import "github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2018-04-01/compute"
Package compute implements the Azure ARM Compute service API version 2018-04-01.
Compute Client
availabilitysets.go client.go disks.go images.go loganalytics.go models.go operations.go proximityplacementgroups.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 AdditionalUnattendContent struct {
// PassName - The pass name. Currently, the only allowable value is OobeSystem. Possible values include: 'OobeSystem'
PassName PassNames `json:"passName,omitempty"`
// ComponentName - The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: 'MicrosoftWindowsShellSetup'
ComponentName ComponentNames `json:"componentName,omitempty"`
// SettingName - Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands'
SettingName SettingNames `json:"settingName,omitempty"`
// Content - Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
Content *string `json:"content,omitempty"`
}AdditionalUnattendContent specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
type 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
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(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.
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.
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 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.
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.
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"`
}DiskProperties disk resource properties.
type DiskSku struct {
// Name - The sku name. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS'
Name StorageAccountTypes `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, or StandardSSD_LRS.
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"`
}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.
DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *DisksCreateOrUpdateFuture) Result(client DisksClient) (d Disk, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *DisksDeleteFuture) Result(client DisksClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
DisksGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *DisksGrantAccessFuture) Result(client DisksClient) (au AccessURI, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
DisksRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *DisksRevokeAccessFuture) Result(client DisksClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
DisksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *DisksUpdateFuture) Result(client DisksClient) (d Disk, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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 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: 'BasicA0', 'BasicA1', 'BasicA2', 'BasicA3', 'BasicA4', 'StandardA0', 'StandardA1', 'StandardA2', 'StandardA3', 'StandardA4', 'StandardA5', 'StandardA6', 'StandardA7', 'StandardA8', 'StandardA9', 'StandardA10', 'StandardA11', 'StandardA1V2', 'StandardA2V2', 'StandardA4V2', 'StandardA8V2', 'StandardA2mV2', 'StandardA4mV2', 'StandardA8mV2', 'StandardB1s', 'StandardB1ms', 'StandardB2s', 'StandardB2ms', 'StandardB4ms', 'StandardB8ms', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD2V3', 'StandardD4V3', 'StandardD8V3', 'StandardD16V3', 'StandardD32V3', 'StandardD64V3', 'StandardD2sV3', 'StandardD4sV3', 'StandardD8sV3', 'StandardD16sV3', 'StandardD32sV3', 'StandardD64sV3', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardD15V2', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardDS1V2', 'StandardDS2V2', 'StandardDS3V2', 'StandardDS4V2', 'StandardDS5V2', 'StandardDS11V2', 'StandardDS12V2', 'StandardDS13V2', 'StandardDS14V2', 'StandardDS15V2', 'StandardDS134V2', 'StandardDS132V2', 'StandardDS148V2', 'StandardDS144V2', 'StandardE2V3', 'StandardE4V3', 'StandardE8V3', 'StandardE16V3', 'StandardE32V3', 'StandardE64V3', 'StandardE2sV3', 'StandardE4sV3', 'StandardE8sV3', 'StandardE16sV3', 'StandardE32sV3', 'StandardE64sV3', 'StandardE3216V3', 'StandardE328sV3', 'StandardE6432sV3', 'StandardE6416sV3', 'StandardF1', 'StandardF2', 'StandardF4', 'StandardF8', 'StandardF16', 'StandardF1s', 'StandardF2s', 'StandardF4s', 'StandardF8s', 'StandardF16s', 'StandardF2sV2', 'StandardF4sV2', 'StandardF8sV2', 'StandardF16sV2', 'StandardF32sV2', 'StandardF64sV2', 'StandardF72sV2', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5', 'StandardGS48', 'StandardGS44', 'StandardGS516', 'StandardGS58', 'StandardH8', 'StandardH16', 'StandardH8m', 'StandardH16m', 'StandardH16r', 'StandardH16mr', 'StandardL4s', 'StandardL8s', 'StandardL16s', 'StandardL32s', 'StandardM64s', 'StandardM64ms', 'StandardM128s', 'StandardM128ms', 'StandardM6432ms', 'StandardM6416ms', 'StandardM12864ms', 'StandardM12832ms', 'StandardNC6', 'StandardNC12', 'StandardNC24', 'StandardNC24r', 'StandardNC6sV2', 'StandardNC12sV2', 'StandardNC24sV2', 'StandardNC24rsV2', 'StandardNC6sV3', 'StandardNC12sV3', 'StandardNC24sV3', 'StandardNC24rsV3', 'StandardND6s', 'StandardND12s', 'StandardND24s', 'StandardND24rs', 'StandardNV6', 'StandardNV12', 'StandardNV24'
VMSize VirtualMachineSizeTypes `json:"vmSize,omitempty"`
}HardwareProfile specifies the hardware settings for the virtual machine.
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. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS'
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(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. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS'
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.
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.
ImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ImagesCreateOrUpdateFuture) Result(client ImagesClient) (i Image, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ImagesDeleteFuture) Result(client ImagesClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
ImagesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *ImagesUpdateFuture) Result(client ImagesClient) (i Image, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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"`
}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(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.
LogAnalyticsExportRequestRateByIntervalFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LogAnalyticsExportRequestRateByIntervalFuture) Result(client LogAnalyticsClient) (laor LogAnalyticsOperationResult, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
LogAnalyticsExportThrottledRequestsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *LogAnalyticsExportThrottledRequestsFuture) Result(client LogAnalyticsClient) (laor LogAnalyticsOperationResult, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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.
type ManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS'
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"`
// 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"`
}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.
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(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.
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 string) (result autorest.Response, err error)
Delete delete a proximity placement group. Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group.
func (client ProximityPlacementGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProximityPlacementGroupsClient) 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 ProximityPlacementGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) Get(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string) (result ProximityPlacementGroup, err error)
Get retrieves information about a proximity placement group . Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group.
func (client ProximityPlacementGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ProximityPlacementGroupsClient) GetResponder(resp *http.Response) (result ProximityPlacementGroup, 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 ProximityPlacementGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProximityPlacementGroupListResultPage, err error)
ListByResourceGroup lists all proximity placement groups in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ProximityPlacementGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProximityPlacementGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProximityPlacementGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ProximityPlacementGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result ProximityPlacementGroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) 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 ProximityPlacementGroupsClient) ListBySubscription(ctx context.Context) (result ProximityPlacementGroupListResultPage, err error)
ListBySubscription lists all proximity placement groups in a subscription.
func (client ProximityPlacementGroupsClient) ListBySubscriptionComplete(ctx context.Context) (result ProximityPlacementGroupListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProximityPlacementGroupsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client ProximityPlacementGroupsClient) ListBySubscriptionResponder(resp *http.Response) (result ProximityPlacementGroupListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) 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 ProximityPlacementGroupsClient) Update(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroupUpdate) (result ProximityPlacementGroup, err error)
Update 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 Update Proximity Placement Group operation.
func (client ProximityPlacementGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ProximityPlacementGroupsClient) UpdateResponder(resp *http.Response) (result ProximityPlacementGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type PurchasePlan struct {
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Name - The plan ID.
Name *string `json:"name,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"`
}PurchasePlan used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
type RecoveryWalkResponse struct {
autorest.Response `json:"-"`
// WalkPerformed - READ-ONLY; Whether the recovery walk was performed
WalkPerformed *bool `json:"walkPerformed,omitempty"`
// NextPlatformUpdateDomain - READ-ONLY; The next update domain that needs to be walked. Null means walk spanning all update domains has been completed
NextPlatformUpdateDomain *int32 `json:"nextPlatformUpdateDomain,omitempty"`
}RecoveryWalkResponse response after calling a manual recovery walk
type RequestRateByIntervalInput struct {
// IntervalLength - Interval value in minutes used to create LogAnalytics call rate logs. Possible values include: 'ThreeMins', 'FiveMins', 'ThirtyMins', 'SixtyMins'
IntervalLength IntervalInMins `json:"intervalLength,omitempty"`
// 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"`
}RequestRateByIntervalInput api request input for LogAnalytics getRequestRateByInterval Api.
type Resource struct {
// 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"`
}Resource the Resource model definition.
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
const (
// ResourceIdentityTypeNone ...
ResourceIdentityTypeNone ResourceIdentityType = "None"
// ResourceIdentityTypeSystemAssigned ...
ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
// ResourceIdentityTypeSystemAssignedUserAssigned ...
ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
// ResourceIdentityTypeUserAssigned ...
ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
type RollbackStatusInfo struct {
// SuccessfullyRolledbackInstanceCount - READ-ONLY; The number of instances which have been successfully rolled back.
SuccessfullyRolledbackInstanceCount *int32 `json:"successfullyRolledbackInstanceCount,omitempty"`
// FailedRolledbackInstanceCount - READ-ONLY; The number of instances which failed to rollback.
FailedRolledbackInstanceCount *int32 `json:"failedRolledbackInstanceCount,omitempty"`
// RollbackError - READ-ONLY; Error details if OS rollback failed.
RollbackError *APIError `json:"rollbackError,omitempty"`
}RollbackStatusInfo information about rollback on failed VM instances after a OS Upgrade operation.
RollingUpgradeActionType enumerates the values for rolling upgrade action type.
const (
// Cancel ...
Cancel RollingUpgradeActionType = "Cancel"
// Start ...
Start RollingUpgradeActionType = "Start"
)func PossibleRollingUpgradeActionTypeValues() []RollingUpgradeActionType
PossibleRollingUpgradeActionTypeValues returns an array of possible values for the RollingUpgradeActionType const type.
type RollingUpgradePolicy struct {
// MaxBatchInstancePercent - The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
MaxBatchInstancePercent *int32 `json:"maxBatchInstancePercent,omitempty"`
// MaxUnhealthyInstancePercent - The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
MaxUnhealthyInstancePercent *int32 `json:"maxUnhealthyInstancePercent,omitempty"`
// MaxUnhealthyUpgradedInstancePercent - The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
MaxUnhealthyUpgradedInstancePercent *int32 `json:"maxUnhealthyUpgradedInstancePercent,omitempty"`
// PauseTimeBetweenBatches - The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
PauseTimeBetweenBatches *string `json:"pauseTimeBetweenBatches,omitempty"`
}RollingUpgradePolicy the configuration parameters used while performing a rolling upgrade.
type RollingUpgradeProgressInfo struct {
// SuccessfulInstanceCount - READ-ONLY; The number of instances that have been successfully upgraded.
SuccessfulInstanceCount *int32 `json:"successfulInstanceCount,omitempty"`
// FailedInstanceCount - READ-ONLY; The number of instances that have failed to be upgraded successfully.
FailedInstanceCount *int32 `json:"failedInstanceCount,omitempty"`
// InProgressInstanceCount - READ-ONLY; The number of instances that are currently being upgraded.
InProgressInstanceCount *int32 `json:"inProgressInstanceCount,omitempty"`
// PendingInstanceCount - READ-ONLY; The number of instances that have not yet begun to be upgraded.
PendingInstanceCount *int32 `json:"pendingInstanceCount,omitempty"`
}RollingUpgradeProgressInfo information about the number of virtual machine instances in each upgrade state.
type RollingUpgradeRunningStatus struct {
// Code - READ-ONLY; Code indicating the current status of the upgrade. Possible values include: 'RollingForward', 'Cancelled', 'Completed', 'Faulted'
Code RollingUpgradeStatusCode `json:"code,omitempty"`
// StartTime - READ-ONLY; Start time of the upgrade.
StartTime *date.Time `json:"startTime,omitempty"`
// LastAction - READ-ONLY; The last action performed on the rolling upgrade. Possible values include: 'Start', 'Cancel'
LastAction RollingUpgradeActionType `json:"lastAction,omitempty"`
// LastActionTime - READ-ONLY; Last action time of the upgrade.
LastActionTime *date.Time `json:"lastActionTime,omitempty"`
}RollingUpgradeRunningStatus information about the current running state of the overall upgrade.
RollingUpgradeStatusCode enumerates the values for rolling upgrade status code.
const (
// Cancelled ...
Cancelled RollingUpgradeStatusCode = "Cancelled"
// Completed ...
Completed RollingUpgradeStatusCode = "Completed"
// Faulted ...
Faulted RollingUpgradeStatusCode = "Faulted"
// RollingForward ...
RollingForward RollingUpgradeStatusCode = "RollingForward"
)func PossibleRollingUpgradeStatusCodeValues() []RollingUpgradeStatusCode
PossibleRollingUpgradeStatusCodeValues returns an array of possible values for the RollingUpgradeStatusCode const type.
type RollingUpgradeStatusInfo struct {
autorest.Response `json:"-"`
*RollingUpgradeStatusInfoProperties `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"`
}RollingUpgradeStatusInfo the status of the latest virtual machine scale set rolling upgrade.
func (rusi RollingUpgradeStatusInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeStatusInfo.
func (rusi *RollingUpgradeStatusInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RollingUpgradeStatusInfo struct.
type RollingUpgradeStatusInfoProperties struct {
// Policy - READ-ONLY; The rolling upgrade policies applied for this upgrade.
Policy *RollingUpgradePolicy `json:"policy,omitempty"`
// RunningStatus - READ-ONLY; Information about the current running state of the overall upgrade.
RunningStatus *RollingUpgradeRunningStatus `json:"runningStatus,omitempty"`
// Progress - READ-ONLY; Information about the number of virtual machine instances in each upgrade state.
Progress *RollingUpgradeProgressInfo `json:"progress,omitempty"`
// Error - READ-ONLY; Error details for this upgrade, if there are any.
Error *APIError `json:"error,omitempty"`
}RollingUpgradeStatusInfoProperties the status of the latest virtual machine scale set rolling upgrade.
type RunCommandDocument struct {
autorest.Response `json:"-"`
// Script - The script to be executed.
Script *[]string `json:"script,omitempty"`
// Parameters - The parameters used by the script.
Parameters *[]RunCommandParameterDefinition `json:"parameters,omitempty"`
// Schema - The VM run command schema.
Schema *string `json:"$schema,omitempty"`
// ID - The VM run command id.
ID *string `json:"id,omitempty"`
// OsType - The Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// Label - The VM run command label.
Label *string `json:"label,omitempty"`
// Description - The VM run command description.
Description *string `json:"description,omitempty"`
}RunCommandDocument describes the properties of a Run Command.
type RunCommandDocumentBase struct {
// Schema - The VM run command schema.
Schema *string `json:"$schema,omitempty"`
// ID - The VM run command id.
ID *string `json:"id,omitempty"`
// OsType - The Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// Label - The VM run command label.
Label *string `json:"label,omitempty"`
// Description - The VM run command description.
Description *string `json:"description,omitempty"`
}RunCommandDocumentBase describes the properties of a Run Command metadata.
type RunCommandInput struct {
// CommandID - The run command id.
CommandID *string `json:"commandId,omitempty"`
// Script - Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
Script *[]string `json:"script,omitempty"`
// Parameters - The run command parameters.
Parameters *[]RunCommandInputParameter `json:"parameters,omitempty"`
}RunCommandInput capture Virtual Machine parameters.
type RunCommandInputParameter struct {
// Name - The run command parameter name.
Name *string `json:"name,omitempty"`
// Value - The run command parameter value.
Value *string `json:"value,omitempty"`
}RunCommandInputParameter describes the properties of a run command parameter.
type RunCommandListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine run commands.
Value *[]RunCommandDocumentBase `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.
NextLink *string `json:"nextLink,omitempty"`
}RunCommandListResult the List Virtual Machine operation response.
func (rclr RunCommandListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type RunCommandListResultIterator struct {
// contains filtered or unexported fields
}RunCommandListResultIterator provides access to a complete listing of RunCommandDocumentBase values.
func NewRunCommandListResultIterator(page RunCommandListResultPage) RunCommandListResultIterator
Creates a new instance of the RunCommandListResultIterator type.
func (iter *RunCommandListResultIterator) 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 *RunCommandListResultIterator) 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 RunCommandListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RunCommandListResultIterator) Response() RunCommandListResult
Response returns the raw server response from the last page request.
func (iter RunCommandListResultIterator) Value() RunCommandDocumentBase
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type RunCommandListResultPage struct {
// contains filtered or unexported fields
}RunCommandListResultPage contains a page of RunCommandDocumentBase values.
func NewRunCommandListResultPage(getNextPage func(context.Context, RunCommandListResult) (RunCommandListResult, error)) RunCommandListResultPage
Creates a new instance of the RunCommandListResultPage type.
func (page *RunCommandListResultPage) 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 *RunCommandListResultPage) 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 RunCommandListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RunCommandListResultPage) Response() RunCommandListResult
Response returns the raw server response from the last page request.
func (page RunCommandListResultPage) Values() []RunCommandDocumentBase
Values returns the slice of values for the current page or nil if there are no values.
type RunCommandParameterDefinition struct {
// Name - The run command parameter name.
Name *string `json:"name,omitempty"`
// Type - The run command parameter type.
Type *string `json:"type,omitempty"`
// DefaultValue - The run command parameter default value.
DefaultValue *string `json:"defaultValue,omitempty"`
// Required - The run command parameter required.
Required *bool `json:"required,omitempty"`
}RunCommandParameterDefinition describes the properties of a run command parameter.
type RunCommandResult struct {
autorest.Response `json:"-"`
// Value - Run command operation response.
Value *[]InstanceViewStatus `json:"value,omitempty"`
}RunCommandResult ...
type SSHConfiguration struct {
// PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys *[]SSHPublicKey `json:"publicKeys,omitempty"`
}SSHConfiguration SSH configuration for Linux based VMs running on Azure
type SSHPublicKey struct {
// Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
Path *string `json:"path,omitempty"`
// KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
KeyData *string `json:"keyData,omitempty"`
}SSHPublicKey contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
SettingNames enumerates the values for setting names.
const (
// AutoLogon ...
AutoLogon SettingNames = "AutoLogon"
// FirstLogonCommands ...
FirstLogonCommands SettingNames = "FirstLogonCommands"
)func PossibleSettingNamesValues() []SettingNames
PossibleSettingNamesValues returns an array of possible values for the SettingNames const type.
type Sku struct {
// Name - The sku name.
Name *string `json:"name,omitempty"`
// Tier - Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**
Tier *string `json:"tier,omitempty"`
// Capacity - Specifies the number of virtual machines in the scale set.
Capacity *int64 `json:"capacity,omitempty"`
}Sku describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
type Snapshot struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; Unused. Always Null.
ManagedBy *string `json:"managedBy,omitempty"`
Sku *SnapshotSku `json:"sku,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"`
}Snapshot snapshot resource.
MarshalJSON is the custom marshaler for Snapshot.
UnmarshalJSON is the custom unmarshaler for Snapshot struct.
type SnapshotList struct {
autorest.Response `json:"-"`
// Value - A list of snapshots.
Value *[]Snapshot `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.
NextLink *string `json:"nextLink,omitempty"`
}SnapshotList the List Snapshots operation response.
func (sl SnapshotList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SnapshotListIterator struct {
// contains filtered or unexported fields
}SnapshotListIterator provides access to a complete listing of Snapshot values.
func NewSnapshotListIterator(page SnapshotListPage) SnapshotListIterator
Creates a new instance of the SnapshotListIterator type.
func (iter *SnapshotListIterator) 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 *SnapshotListIterator) 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 SnapshotListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SnapshotListIterator) Response() SnapshotList
Response returns the raw server response from the last page request.
func (iter SnapshotListIterator) Value() Snapshot
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type SnapshotListPage struct {
// contains filtered or unexported fields
}SnapshotListPage contains a page of Snapshot values.
func NewSnapshotListPage(getNextPage func(context.Context, SnapshotList) (SnapshotList, error)) SnapshotListPage
Creates a new instance of the SnapshotListPage type.
func (page *SnapshotListPage) 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 *SnapshotListPage) 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 SnapshotListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SnapshotListPage) Response() SnapshotList
Response returns the raw server response from the last page request.
func (page SnapshotListPage) Values() []Snapshot
Values returns the slice of values for the current page or nil if there are no values.
type SnapshotSku struct {
// Name - The sku name. Possible values include: 'StandardLRS', 'PremiumLRS', 'StandardZRS'
Name SnapshotStorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}SnapshotSku the snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.
SnapshotStorageAccountTypes enumerates the values for snapshot storage account types.
const (
// PremiumLRS ...
PremiumLRS SnapshotStorageAccountTypes = "Premium_LRS"
// StandardLRS ...
StandardLRS SnapshotStorageAccountTypes = "Standard_LRS"
// StandardZRS ...
StandardZRS SnapshotStorageAccountTypes = "Standard_ZRS"
)func PossibleSnapshotStorageAccountTypesValues() []SnapshotStorageAccountTypes
PossibleSnapshotStorageAccountTypesValues returns an array of possible values for the SnapshotStorageAccountTypes const type.
type SnapshotUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *SnapshotSku `json:"sku,omitempty"`
}SnapshotUpdate snapshot update resource.
func (su SnapshotUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SnapshotUpdate.
func (su *SnapshotUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SnapshotUpdate struct.
type SnapshotsClient struct {
BaseClient
}SnapshotsClient is the compute Client
func NewSnapshotsClient(subscriptionID string) SnapshotsClient
NewSnapshotsClient creates an instance of the SnapshotsClient client.
func NewSnapshotsClientWithBaseURI(baseURI string, subscriptionID string) SnapshotsClient
NewSnapshotsClientWithBaseURI creates an instance of the SnapshotsClient 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 SnapshotsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, snapshotName string, snapshot Snapshot) (result SnapshotsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. snapshot - snapshot object supplied in the body of the Put disk operation.
func (client SnapshotsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, snapshotName string, snapshot Snapshot) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SnapshotsClient) CreateOrUpdateResponder(resp *http.Response) (result Snapshot, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SnapshotsClient) CreateOrUpdateSender(req *http.Request) (future SnapshotsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Delete(ctx context.Context, resourceGroupName string, snapshotName string) (result SnapshotsDeleteFuture, err error)
Delete deletes a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.
func (client SnapshotsClient) DeletePreparer(ctx context.Context, resourceGroupName string, snapshotName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SnapshotsClient) 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 SnapshotsClient) DeleteSender(req *http.Request) (future SnapshotsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Get(ctx context.Context, resourceGroupName string, snapshotName string) (result Snapshot, err error)
Get gets information about a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.
func (client SnapshotsClient) GetPreparer(ctx context.Context, resourceGroupName string, snapshotName 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 SnapshotsClient) GrantAccess(ctx context.Context, resourceGroupName string, snapshotName string, grantAccessData GrantAccessData) (result SnapshotsGrantAccessFuture, err error)
GrantAccess grants access to a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. grantAccessData - access data object supplied in the body of the get snapshot access operation.
func (client SnapshotsClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, snapshotName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
func (client SnapshotsClient) GrantAccessResponder(resp *http.Response) (result AccessURI, err error)
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client SnapshotsClient) GrantAccessSender(req *http.Request) (future SnapshotsGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) List(ctx context.Context) (result SnapshotListPage, err error)
List lists snapshots under a subscription.
func (client SnapshotsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result SnapshotListPage, err error)
ListByResourceGroup lists snapshots under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client SnapshotsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result SnapshotListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SnapshotsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client SnapshotsClient) ListByResourceGroupResponder(resp *http.Response) (result SnapshotList, 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 SnapshotsClient) ListComplete(ctx context.Context) (result SnapshotListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client SnapshotsClient) ListResponder(resp *http.Response) (result SnapshotList, 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 SnapshotsClient) RevokeAccess(ctx context.Context, resourceGroupName string, snapshotName string) (result SnapshotsRevokeAccessFuture, err error)
RevokeAccess revokes access to a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.
func (client SnapshotsClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, snapshotName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client SnapshotsClient) 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 SnapshotsClient) RevokeAccessSender(req *http.Request) (future SnapshotsRevokeAccessFuture, err error)
RevokeAccessSender sends the RevokeAccess request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Update(ctx context.Context, resourceGroupName string, snapshotName string, snapshot SnapshotUpdate) (result SnapshotsUpdateFuture, err error)
Update updates (patches) a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters. snapshot - snapshot object supplied in the body of the Patch snapshot operation.
func (client SnapshotsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, snapshotName string, snapshot SnapshotUpdate) (*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 SnapshotsClient) UpdateSender(req *http.Request) (future SnapshotsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SnapshotsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SnapshotsCreateOrUpdateFuture) Result(client SnapshotsClient) (s Snapshot, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SnapshotsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SnapshotsDeleteFuture) Result(client SnapshotsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SnapshotsGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SnapshotsGrantAccessFuture) Result(client SnapshotsClient) (au AccessURI, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SnapshotsRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SnapshotsRevokeAccessFuture) Result(client SnapshotsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SnapshotsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SnapshotsUpdateFuture) Result(client SnapshotsClient) (s Snapshot, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SourceVault the vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
StatusLevelTypes enumerates the values for status level types.
const (
// Error ...
Error StatusLevelTypes = "Error"
// Info ...
Info StatusLevelTypes = "Info"
// Warning ...
Warning StatusLevelTypes = "Warning"
)func PossibleStatusLevelTypesValues() []StatusLevelTypes
PossibleStatusLevelTypesValues returns an array of possible values for the StatusLevelTypes const type.
StorageAccountTypes enumerates the values for storage account types.
const (
// StorageAccountTypesPremiumLRS ...
StorageAccountTypesPremiumLRS StorageAccountTypes = "Premium_LRS"
// StorageAccountTypesStandardLRS ...
StorageAccountTypesStandardLRS StorageAccountTypes = "Standard_LRS"
// StorageAccountTypesStandardSSDLRS ...
StorageAccountTypesStandardSSDLRS StorageAccountTypes = "StandardSSD_LRS"
)func PossibleStorageAccountTypesValues() []StorageAccountTypes
PossibleStorageAccountTypesValues returns an array of possible values for the StorageAccountTypes const type.
type StorageProfile struct {
// 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.
ImageReference *ImageReference `json:"imageReference,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).
OsDisk *OSDisk `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 *[]DataDisk `json:"dataDisks,omitempty"`
}StorageProfile specifies the storage settings for the virtual machine disks.
SubResource ...
type SubResourceReadOnly struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}SubResourceReadOnly ...
type ThrottledRequestsInput 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"`
}ThrottledRequestsInput api request input for LogAnalytics getThrottledRequests Api.
UpdateResource the Update Resource model definition.
func (ur UpdateResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateResource.
UpgradeMode enumerates the values for upgrade mode.
const (
// Automatic ...
Automatic UpgradeMode = "Automatic"
// Manual ...
Manual UpgradeMode = "Manual"
// Rolling ...
Rolling UpgradeMode = "Rolling"
)func PossibleUpgradeModeValues() []UpgradeMode
PossibleUpgradeModeValues returns an array of possible values for the UpgradeMode const type.
type UpgradeOperationHistoricalStatusInfo struct {
// Properties - READ-ONLY; Information about the properties of the upgrade operation.
Properties *UpgradeOperationHistoricalStatusInfoProperties `json:"properties,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}UpgradeOperationHistoricalStatusInfo virtual Machine Scale Set OS Upgrade History operation response.
type UpgradeOperationHistoricalStatusInfoProperties struct {
// RunningStatus - READ-ONLY; Information about the overall status of the upgrade operation.
RunningStatus *UpgradeOperationHistoryStatus `json:"runningStatus,omitempty"`
// Progress - READ-ONLY; Counts of the VMs in each state.
Progress *RollingUpgradeProgressInfo `json:"progress,omitempty"`
// Error - READ-ONLY; Error Details for this upgrade if there are any.
Error *APIError `json:"error,omitempty"`
// StartedBy - READ-ONLY; Invoker of the Upgrade Operation. Possible values include: 'Unknown', 'User', 'Platform'
StartedBy UpgradeOperationInvoker `json:"startedBy,omitempty"`
// TargetImageReference - READ-ONLY; Image Reference details
TargetImageReference *ImageReference `json:"targetImageReference,omitempty"`
// RollbackInfo - READ-ONLY; Information about OS rollback if performed
RollbackInfo *RollbackStatusInfo `json:"rollbackInfo,omitempty"`
}UpgradeOperationHistoricalStatusInfoProperties describes each OS upgrade on the Virtual Machine Scale Set.
type UpgradeOperationHistoryStatus struct {
// Code - READ-ONLY; Code indicating the current status of the upgrade. Possible values include: 'UpgradeStateRollingForward', 'UpgradeStateCancelled', 'UpgradeStateCompleted', 'UpgradeStateFaulted'
Code UpgradeState `json:"code,omitempty"`
// StartTime - READ-ONLY; Start time of the upgrade.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; End time of the upgrade.
EndTime *date.Time `json:"endTime,omitempty"`
}UpgradeOperationHistoryStatus information about the current running state of the overall upgrade.
UpgradeOperationInvoker enumerates the values for upgrade operation invoker.
const (
// Platform ...
Platform UpgradeOperationInvoker = "Platform"
// Unknown ...
Unknown UpgradeOperationInvoker = "Unknown"
// User ...
User UpgradeOperationInvoker = "User"
)func PossibleUpgradeOperationInvokerValues() []UpgradeOperationInvoker
PossibleUpgradeOperationInvokerValues returns an array of possible values for the UpgradeOperationInvoker const type.
type UpgradePolicy struct {
// Mode - Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time. Possible values include: 'Automatic', 'Manual', 'Rolling'
Mode UpgradeMode `json:"mode,omitempty"`
// RollingUpgradePolicy - The configuration parameters used while performing a rolling upgrade.
RollingUpgradePolicy *RollingUpgradePolicy `json:"rollingUpgradePolicy,omitempty"`
// AutomaticOSUpgrade - Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.
AutomaticOSUpgrade *bool `json:"automaticOSUpgrade,omitempty"`
// AutoOSUpgradePolicy - Configuration parameters used for performing automatic OS Upgrade.
AutoOSUpgradePolicy *AutoOSUpgradePolicy `json:"autoOSUpgradePolicy,omitempty"`
}UpgradePolicy describes an upgrade policy - automatic, manual, or rolling.
UpgradeState enumerates the values for upgrade state.
const (
// UpgradeStateCancelled ...
UpgradeStateCancelled UpgradeState = "Cancelled"
// UpgradeStateCompleted ...
UpgradeStateCompleted UpgradeState = "Completed"
// UpgradeStateFaulted ...
UpgradeStateFaulted UpgradeState = "Faulted"
// UpgradeStateRollingForward ...
UpgradeStateRollingForward UpgradeState = "RollingForward"
)func PossibleUpgradeStateValues() []UpgradeState
PossibleUpgradeStateValues returns an array of possible values for the UpgradeState const type.
type Usage struct {
// Unit - An enum describing the unit of usage measurement.
Unit *string `json:"unit,omitempty"`
// CurrentValue - The current usage of the resource.
CurrentValue *int32 `json:"currentValue,omitempty"`
// Limit - The maximum permitted usage of the resource.
Limit *int64 `json:"limit,omitempty"`
// Name - The name of the type of usage.
Name *UsageName `json:"name,omitempty"`
}Usage describes Compute Resource Usage.
type UsageClient struct {
BaseClient
}UsageClient is the compute Client
func NewUsageClient(subscriptionID string) UsageClient
NewUsageClient creates an instance of the UsageClient client.
func NewUsageClientWithBaseURI(baseURI string, subscriptionID string) UsageClient
NewUsageClientWithBaseURI creates an instance of the UsageClient 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 UsageClient) List(ctx context.Context, location string) (result ListUsagesResultPage, err error)
List gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription. Parameters: location - the location for which resource usage is queried.
func (client UsageClient) ListComplete(ctx context.Context, location string) (result ListUsagesResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UsageClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client UsageClient) ListResponder(resp *http.Response) (result ListUsagesResult, 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 UsageName struct {
// Value - The name of the resource.
Value *string `json:"value,omitempty"`
// LocalizedValue - The localized name of the resource.
LocalizedValue *string `json:"localizedValue,omitempty"`
}UsageName the Usage Names.
type VaultCertificate struct {
// CertificateURL - This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>}
CertificateURL *string `json:"certificateUrl,omitempty"`
// CertificateStore - For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
CertificateStore *string `json:"certificateStore,omitempty"`
}VaultCertificate describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
type VaultSecretGroup struct {
// SourceVault - The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
SourceVault *SubResource `json:"sourceVault,omitempty"`
// VaultCertificates - The list of key vault references in SourceVault which contain certificates.
VaultCertificates *[]VaultCertificate `json:"vaultCertificates,omitempty"`
}VaultSecretGroup describes a set of certificates which are all in the same Key Vault.
type VirtualHardDisk struct {
// URI - Specifies the virtual hard disk's uri.
URI *string `json:"uri,omitempty"`
}VirtualHardDisk describes the uri of a disk.
type VirtualMachine struct {
autorest.Response `json:"-"`
// 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**.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineProperties `json:"properties,omitempty"`
// Resources - READ-ONLY; The virtual machine child extension resources.
Resources *[]VirtualMachineExtension `json:"resources,omitempty"`
// Identity - The identity of the virtual machine, if configured.
Identity *VirtualMachineIdentity `json:"identity,omitempty"`
// Zones - The virtual machine zones.
Zones *[]string `json:"zones,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"`
}VirtualMachine describes a Virtual Machine.
func (VM VirtualMachine) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachine.
func (VM *VirtualMachine) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachine struct.
type VirtualMachineAgentInstanceView struct {
// VMAgentVersion - The VM Agent full version.
VMAgentVersion *string `json:"vmAgentVersion,omitempty"`
// ExtensionHandlers - The virtual machine extension handler instance view.
ExtensionHandlers *[]VirtualMachineExtensionHandlerInstanceView `json:"extensionHandlers,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}VirtualMachineAgentInstanceView the instance view of the VM Agent running on the virtual machine.
type VirtualMachineCaptureParameters struct {
// VhdPrefix - The captured virtual hard disk's name prefix.
VhdPrefix *string `json:"vhdPrefix,omitempty"`
// DestinationContainerName - The destination container name.
DestinationContainerName *string `json:"destinationContainerName,omitempty"`
// OverwriteVhds - Specifies whether to overwrite the destination virtual hard disk, in case of conflict.
OverwriteVhds *bool `json:"overwriteVhds,omitempty"`
}VirtualMachineCaptureParameters capture Virtual Machine parameters.
type VirtualMachineCaptureResult struct {
autorest.Response `json:"-"`
// Schema - READ-ONLY; the schema of the captured virtual machine
Schema *string `json:"$schema,omitempty"`
// ContentVersion - READ-ONLY; the version of the content
ContentVersion *string `json:"contentVersion,omitempty"`
// Parameters - READ-ONLY; parameters of the captured virtual machine
Parameters interface{} `json:"parameters,omitempty"`
// Resources - READ-ONLY; a list of resource items of the captured virtual machine
Resources *[]interface{} `json:"resources,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}VirtualMachineCaptureResult output of virtual machine capture operation.
VirtualMachineEvictionPolicyTypes enumerates the values for virtual machine eviction policy types.
const (
// Deallocate ...
Deallocate VirtualMachineEvictionPolicyTypes = "Deallocate"
// Delete ...
Delete VirtualMachineEvictionPolicyTypes = "Delete"
)func PossibleVirtualMachineEvictionPolicyTypesValues() []VirtualMachineEvictionPolicyTypes
PossibleVirtualMachineEvictionPolicyTypesValues returns an array of possible values for the VirtualMachineEvictionPolicyTypes const type.
type VirtualMachineExtension struct {
autorest.Response `json:"-"`
*VirtualMachineExtensionProperties `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"`
}VirtualMachineExtension describes a Virtual Machine Extension.
func (vme VirtualMachineExtension) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtension.
func (vme *VirtualMachineExtension) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtension struct.
type VirtualMachineExtensionHandlerInstanceView struct {
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// Status - The extension handler status.
Status *InstanceViewStatus `json:"status,omitempty"`
}VirtualMachineExtensionHandlerInstanceView the instance view of a virtual machine extension handler.
type VirtualMachineExtensionImage struct {
autorest.Response `json:"-"`
*VirtualMachineExtensionImageProperties `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"`
}VirtualMachineExtensionImage describes a Virtual Machine Extension Image.
func (vmei VirtualMachineExtensionImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionImage.
func (vmei *VirtualMachineExtensionImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtensionImage struct.
type VirtualMachineExtensionImageProperties struct {
// OperatingSystem - The operating system this extension supports.
OperatingSystem *string `json:"operatingSystem,omitempty"`
// ComputeRole - The type of role (IaaS or PaaS) this extension supports.
ComputeRole *string `json:"computeRole,omitempty"`
// HandlerSchema - The schema defined by publisher, where extension consumers should provide settings in a matching schema.
HandlerSchema *string `json:"handlerSchema,omitempty"`
// VMScaleSetEnabled - Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
VMScaleSetEnabled *bool `json:"vmScaleSetEnabled,omitempty"`
// SupportsMultipleExtensions - Whether the handler can support multiple extensions.
SupportsMultipleExtensions *bool `json:"supportsMultipleExtensions,omitempty"`
}VirtualMachineExtensionImageProperties describes the properties of a Virtual Machine Extension Image.
type VirtualMachineExtensionImagesClient struct {
BaseClient
}VirtualMachineExtensionImagesClient is the compute Client
func NewVirtualMachineExtensionImagesClient(subscriptionID string) VirtualMachineExtensionImagesClient
NewVirtualMachineExtensionImagesClient creates an instance of the VirtualMachineExtensionImagesClient client.
func NewVirtualMachineExtensionImagesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineExtensionImagesClient
NewVirtualMachineExtensionImagesClientWithBaseURI creates an instance of the VirtualMachineExtensionImagesClient 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 VirtualMachineExtensionImagesClient) Get(ctx context.Context, location string, publisherName string, typeParameter string, version string) (result VirtualMachineExtensionImage, err error)
Get gets a virtual machine extension image. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineExtensionImagesClient) GetPreparer(ctx context.Context, location string, publisherName string, typeParameter string, version string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineExtensionImagesClient) GetResponder(resp *http.Response) (result VirtualMachineExtensionImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionImagesClient) ListTypes(ctx context.Context, location string, publisherName string) (result ListVirtualMachineExtensionImage, err error)
ListTypes gets a list of virtual machine extension image types. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineExtensionImagesClient) ListTypesPreparer(ctx context.Context, location string, publisherName string) (*http.Request, error)
ListTypesPreparer prepares the ListTypes request.
func (client VirtualMachineExtensionImagesClient) ListTypesResponder(resp *http.Response) (result ListVirtualMachineExtensionImage, err error)
ListTypesResponder handles the response to the ListTypes request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) ListTypesSender(req *http.Request) (*http.Response, error)
ListTypesSender sends the ListTypes request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionImagesClient) ListVersions(ctx context.Context, location string, publisherName string, typeParameter string, filter string, top *int32, orderby string) (result ListVirtualMachineExtensionImage, err error)
ListVersions gets a list of virtual machine extension image versions. Parameters: location - the name of a supported Azure region. filter - the filter to apply on the operation.
func (client VirtualMachineExtensionImagesClient) ListVersionsPreparer(ctx context.Context, location string, publisherName string, typeParameter string, filter string, top *int32, orderby string) (*http.Request, error)
ListVersionsPreparer prepares the ListVersions request.
func (client VirtualMachineExtensionImagesClient) ListVersionsResponder(resp *http.Response) (result ListVirtualMachineExtensionImage, err error)
ListVersionsResponder handles the response to the ListVersions request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) ListVersionsSender(req *http.Request) (*http.Response, error)
ListVersionsSender sends the ListVersions request. The method will close the http.Response Body if it receives an error.
type VirtualMachineExtensionInstanceView struct {
// Name - The virtual machine extension name.
Name *string `json:"name,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// Substatuses - The resource status information.
Substatuses *[]InstanceViewStatus `json:"substatuses,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}VirtualMachineExtensionInstanceView the instance view of a virtual machine extension.
type VirtualMachineExtensionProperties struct {
// ForceUpdateTag - How the extension handler should be forced to update even if the extension configuration has not changed.
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// Settings - Json formatted public settings for the extension.
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - The virtual machine extension instance view.
InstanceView *VirtualMachineExtensionInstanceView `json:"instanceView,omitempty"`
}VirtualMachineExtensionProperties describes the properties of a Virtual Machine Extension.
type VirtualMachineExtensionUpdate struct {
*VirtualMachineExtensionUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}VirtualMachineExtensionUpdate describes a Virtual Machine Extension.
func (vmeu VirtualMachineExtensionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionUpdate.
func (vmeu *VirtualMachineExtensionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtensionUpdate struct.
type VirtualMachineExtensionUpdateProperties struct {
// ForceUpdateTag - How the extension handler should be forced to update even if the extension configuration has not changed.
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// Settings - Json formatted public settings for the extension.
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
}VirtualMachineExtensionUpdateProperties describes the properties of a Virtual Machine Extension.
type VirtualMachineExtensionsClient struct {
BaseClient
}VirtualMachineExtensionsClient is the compute Client
func NewVirtualMachineExtensionsClient(subscriptionID string) VirtualMachineExtensionsClient
NewVirtualMachineExtensionsClient creates an instance of the VirtualMachineExtensionsClient client.
func NewVirtualMachineExtensionsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineExtensionsClient
NewVirtualMachineExtensionsClientWithBaseURI creates an instance of the VirtualMachineExtensionsClient 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 VirtualMachineExtensionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtension) (result VirtualMachineExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be created or updated. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Create Virtual Machine Extension operation.
func (client VirtualMachineExtensionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtension) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineExtensionsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineExtension, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) Delete(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string) (result VirtualMachineExtensionsDeleteFuture, err error)
Delete the operation to delete the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be deleted. VMExtensionName - the name of the virtual machine extension.
func (client VirtualMachineExtensionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineExtensionsClient) 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 VirtualMachineExtensionsClient) DeleteSender(req *http.Request) (future VirtualMachineExtensionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) Get(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, expand string) (result VirtualMachineExtension, err error)
Get the operation to get the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the extension. VMExtensionName - the name of the virtual machine extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineExtensionsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineExtensionsClient) GetResponder(resp *http.Response) (result VirtualMachineExtension, 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 VirtualMachineExtensionsClient) List(ctx context.Context, resourceGroupName string, VMName string, expand string) (result VirtualMachineExtensionsListResult, err error)
List the operation to get all extensions of a Virtual Machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineExtensionsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMName string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineExtensionsClient) ListResponder(resp *http.Response) (result VirtualMachineExtensionsListResult, 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 VirtualMachineExtensionsClient) Update(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtensionUpdate) (result VirtualMachineExtensionsUpdateFuture, err error)
Update the operation to update the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be updated. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Update Virtual Machine Extension operation.
func (client VirtualMachineExtensionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtensionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineExtensionsClient) UpdateResponder(resp *http.Response) (result VirtualMachineExtension, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) UpdateSender(req *http.Request) (future VirtualMachineExtensionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineExtensionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *VirtualMachineExtensionsCreateOrUpdateFuture) Result(client VirtualMachineExtensionsClient) (vme VirtualMachineExtension, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
VirtualMachineExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *VirtualMachineExtensionsDeleteFuture) Result(client VirtualMachineExtensionsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type VirtualMachineExtensionsListResult struct {
autorest.Response `json:"-"`
// Value - The list of extensions
Value *[]VirtualMachineExtension `json:"value,omitempty"`
}VirtualMachineExtensionsListResult the List Extension operation response
VirtualMachineExtensionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *VirtualMachineExtensionsUpdateFuture) Result(client VirtualMachineExtensionsClient) (vme VirtualMachineExtension, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type VirtualMachineHealthStatus struct {
// Status - READ-ONLY; The health status information for the VM.
Status *InstanceViewStatus `json:"status,omitempty"`
}VirtualMachineHealthStatus the health status of the VM.
type VirtualMachineIdentity struct {
// PrincipalID - READ-ONLY; The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
// IdentityIds - The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'.
IdentityIds *[]string `json:"identityIds,omitempty"`
}VirtualMachineIdentity identity for the virtual machine.
type VirtualMachineImage struct {
autorest.Response `json:"-"`
*VirtualMachineImageProperties `json:"properties,omitempty"`
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Location - The supported Azure location of the resource.
Location *string `json:"location,omitempty"`
// Tags - Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
Tags map[string]*string `json:"tags"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}VirtualMachineImage describes a Virtual Machine Image.
func (vmi VirtualMachineImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineImage.
func (vmi *VirtualMachineImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineImage struct.
type VirtualMachineImageProperties struct {
Plan *PurchasePlan `json:"plan,omitempty"`
OsDiskImage *OSDiskImage `json:"osDiskImage,omitempty"`
DataDiskImages *[]DataDiskImage `json:"dataDiskImages,omitempty"`
}VirtualMachineImageProperties describes the properties of a Virtual Machine Image.
type VirtualMachineImageResource struct {
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Location - The supported Azure location of the resource.
Location *string `json:"location,omitempty"`
// Tags - Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
Tags map[string]*string `json:"tags"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}VirtualMachineImageResource virtual machine image resource information.
func (vmir VirtualMachineImageResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineImageResource.
type VirtualMachineImagesClient struct {
BaseClient
}VirtualMachineImagesClient is the compute Client
func NewVirtualMachineImagesClient(subscriptionID string) VirtualMachineImagesClient
NewVirtualMachineImagesClient creates an instance of the VirtualMachineImagesClient client.
func NewVirtualMachineImagesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineImagesClient
NewVirtualMachineImagesClientWithBaseURI creates an instance of the VirtualMachineImagesClient 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 VirtualMachineImagesClient) Get(ctx context.Context, location string, publisherName string, offer string, skus string, version string) (result VirtualMachineImage, err error)
Get gets a virtual machine image. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer. skus - a valid image SKU. version - a valid image SKU version.
func (client VirtualMachineImagesClient) GetPreparer(ctx context.Context, location string, publisherName string, offer string, skus string, version string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineImagesClient) GetResponder(resp *http.Response) (result VirtualMachineImage, 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 VirtualMachineImagesClient) List(ctx context.Context, location string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (result ListVirtualMachineImageResource, err error)
List gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer. sku