const (
// DefaultBaseURI is the default URI used for the service Compute
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
APIEntityReference the API entity reference.
type APIEntityReference struct {
// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
ID *string `json:"id,omitempty"`
}
APIError api error.
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"`
}
APIErrorBase api error base.
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"`
}
AccessLevel enumerates the values for access level.
type AccessLevel string
const (
// None ...
None AccessLevel = "None"
// Read ...
Read AccessLevel = "Read"
)
func PossibleAccessLevelValues() []AccessLevel
PossibleAccessLevelValues returns an array of possible values for the AccessLevel const type.
AccessURI a disk access SAS uri.
type AccessURI struct {
autorest.Response `json:"-"`
// AccessURIOutput - Operation output data (raw JSON)
*AccessURIOutput `json:"properties,omitempty"`
}
func (au AccessURI) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccessURI.
func (au *AccessURI) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AccessURI struct.
AccessURIOutput azure properties, including output.
type AccessURIOutput struct {
// AccessURIRaw - Operation output data (raw JSON)
*AccessURIRaw `json:"output,omitempty"`
}
func (auo AccessURIOutput) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccessURIOutput.
func (auo *AccessURIOutput) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AccessURIOutput struct.
AccessURIRaw this object gets 'bubbled up' through flattening.
type AccessURIRaw struct {
// AccessSAS - READ-ONLY; A SAS uri for accessing a disk.
AccessSAS *string `json:"accessSAS,omitempty"`
}
func (aur AccessURIRaw) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccessURIRaw.
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 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"`
}
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.
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"`
}
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.
AvailabilitySetListResult the List Availability Set operation response.
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"`
}
func (aslr AvailabilitySetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AvailabilitySetListResultIterator provides access to a complete listing of AvailabilitySet values.
type AvailabilitySetListResultIterator struct {
// contains filtered or unexported fields
}
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.
AvailabilitySetListResultPage contains a page of AvailabilitySet values.
type AvailabilitySetListResultPage struct {
// contains filtered or unexported fields
}
func NewAvailabilitySetListResultPage(cur AvailabilitySetListResult, getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage
Creates a new instance of the AvailabilitySetListResultPage type.
func (page *AvailabilitySetListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AvailabilitySetListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AvailabilitySetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AvailabilitySetListResultPage) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (page AvailabilitySetListResultPage) Values() []AvailabilitySet
Values returns the slice of values for the current page or nil if there are no values.
AvailabilitySetProperties the instance view of a resource.
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"`
// Statuses - READ-ONLY; The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
func (asp AvailabilitySetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetProperties.
AvailabilitySetsClient is the compute Client
type AvailabilitySetsClient struct {
BaseClient
}
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 OperationStatusResponse, 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 OperationStatusResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (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.
func (client AvailabilitySetsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (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.
func (client AvailabilitySetsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
BaseClient is the base client for Compute.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
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).
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 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"`
}
BootDiagnosticsInstanceView the instance view of a virtual machine boot diagnostics.
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"`
}
func (bdiv BootDiagnosticsInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BootDiagnosticsInstanceView.
CachingTypes enumerates the values for caching types.
type CachingTypes string
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.
type ComponentNames string
const (
// MicrosoftWindowsShellSetup ...
MicrosoftWindowsShellSetup ComponentNames = "Microsoft-Windows-Shell-Setup"
)
func PossibleComponentNamesValues() []ComponentNames
PossibleComponentNamesValues returns an array of possible values for the ComponentNames const type.
CreationData data used when creating a disk.
type CreationData struct {
// CreateOption - This enumerates the possible sources of a disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', 'Import', 'Copy'
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"`
}
DataDisk describes a data 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"`
// 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"`
}
DataDiskImage contains the data disk images information.
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"`
}
func (ddi DataDiskImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataDiskImage.
DiagnosticsProfile specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
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"`
}
Disk disk resource.
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"`
}
func (d Disk) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Disk.
func (d *Disk) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Disk struct.
DiskCreateOption enumerates the values for disk create option.
type DiskCreateOption string
const (
// Attach ...
Attach DiskCreateOption = "Attach"
// Copy ...
Copy DiskCreateOption = "Copy"
// Empty ...
Empty DiskCreateOption = "Empty"
// FromImage ...
FromImage DiskCreateOption = "FromImage"
// Import ...
Import DiskCreateOption = "Import"
)
func PossibleDiskCreateOptionValues() []DiskCreateOption
PossibleDiskCreateOptionValues returns an array of possible values for the DiskCreateOption const type.
DiskCreateOptionTypes enumerates the values for disk create option types.
type DiskCreateOptionTypes string
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.
DiskEncryptionSettings describes a Encryption Settings for a Disk
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"`
}
DiskInstanceView the instance view of the 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"`
}
DiskList the List Disks operation response.
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"`
}
func (dl DiskList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskListIterator provides access to a complete listing of Disk values.
type DiskListIterator struct {
// contains filtered or unexported fields
}
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.
DiskListPage contains a page of Disk values.
type DiskListPage struct {
// contains filtered or unexported fields
}
func NewDiskListPage(cur DiskList, getNextPage func(context.Context, DiskList) (DiskList, error)) DiskListPage
Creates a new instance of the DiskListPage type.
func (page *DiskListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DiskListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DiskListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskListPage) Response() DiskList
Response returns the raw server response from the last page request.
func (page DiskListPage) Values() []Disk
Values returns the slice of values for the current page or nil if there are no values.
DiskProperties disk resource properties.
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"`
}
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
DiskSku the disks and snapshots sku name. Can be Standard_LRS or Premium_LRS.
type DiskSku struct {
// Name - The sku name. Possible values include: 'StandardLRS', 'PremiumLRS'
Name StorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}
func (ds DiskSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskSku.
DiskUpdate disk update resource.
type DiskUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}
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.
DiskUpdateProperties disk resource update properties.
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"`
}
DisksClient is the compute Client
type DisksClient struct {
BaseClient
}
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.
func (client DisksClient) CreateOrUpdateResponder(resp *http.Response) (result Disk, err error)
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 OperationStatusResponse, 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.
func (client DisksClient) GetResponder(resp *http.Response) (result Disk, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DisksClient) 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 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.
func (client DisksClient) 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 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.
func (client DisksClient) 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 DisksClient) ListComplete(ctx context.Context) (result DiskListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client DisksClient) ListResponder(resp *http.Response) (result DiskList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DisksClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (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 OperationStatusResponse, 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.
func (client DisksClient) UpdateResponder(resp *http.Response) (result Disk, err error)
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.
type DisksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}
func (future *DisksCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (OperationStatusResponse, error)
}
func (future *DisksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (AccessURI, error)
}
func (future *DisksGrantAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (OperationStatusResponse, error)
}
func (future *DisksRevokeAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}
func (future *DisksUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EncryptionSettings encryption settings for disk or snapshot
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"`
}
GrantAccessData data used for requesting a SAS.
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"`
}
HardwareProfile specifies the hardware settings for the virtual machine.
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', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardD15V2', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardDS1V2', 'StandardDS2V2', 'StandardDS3V2', 'StandardDS4V2', 'StandardDS5V2', 'StandardDS11V2', 'StandardDS12V2', 'StandardDS13V2', 'StandardDS14V2', 'StandardDS15V2', 'StandardF1', 'StandardF2', 'StandardF4', 'StandardF8', 'StandardF16', 'StandardF1s', 'StandardF2s', 'StandardF4s', 'StandardF8s', 'StandardF16s', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5', 'StandardH8', 'StandardH16', 'StandardH8m', 'StandardH16m', 'StandardH16r', 'StandardH16mr', 'StandardL4s', 'StandardL8s', 'StandardL16s', 'StandardL32s', 'StandardNC6', 'StandardNC12', 'StandardNC24', 'StandardNC24r', 'StandardNV6', 'StandardNV12', 'StandardNV24'
VMSize VirtualMachineSizeTypes `json:"vmSize,omitempty"`
}
IPVersion enumerates the values for ip version.
type IPVersion string
const (
// IPv4 ...
IPv4 IPVersion = "IPv4"
// IPv6 ...
IPv6 IPVersion = "IPv6"
)
func PossibleIPVersionValues() []IPVersion
PossibleIPVersionValues returns an array of possible values for the IPVersion const type.
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.
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"`
}
func (i Image) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Image.
func (i *Image) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Image struct.
ImageDataDisk describes a data disk.
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 or Premium_LRS. Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
}
ImageDiskReference the source image used for creating the 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"`
}
ImageListResult the List Image operation response.
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"`
}
func (ilr ImageListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ImageListResultIterator provides access to a complete listing of Image values.
type ImageListResultIterator struct {
// contains filtered or unexported fields
}
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.
ImageListResultPage contains a page of Image values.
type ImageListResultPage struct {
// contains filtered or unexported fields
}
func NewImageListResultPage(cur ImageListResult, getNextPage func(context.Context, ImageListResult) (ImageListResult, error)) ImageListResultPage
Creates a new instance of the ImageListResultPage type.
func (page *ImageListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ImageListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ImageListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ImageListResultPage) Response() ImageListResult
Response returns the raw server response from the last page request.
func (page ImageListResultPage) Values() []Image
Values returns the slice of values for the current page or nil if there are no values.
ImageOSDisk describes an Operating System disk.
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 or Premium_LRS. Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
}
ImageProperties describes the properties of an Image.
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"`
}
func (IP ImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageProperties.
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 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"`
}
ImageStorageProfile describes a storage profile.
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"`
}
ImagesClient is the compute Client
type ImagesClient struct {
BaseClient
}
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.
func (client ImagesClient) CreateOrUpdateResponder(resp *http.Response) (result Image, err error)
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 OperationStatusResponse, 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.
func (client ImagesClient) GetResponder(resp *http.Response) (result Image, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ImagesClient) 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 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.
func (client ImagesClient) 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 ImagesClient) ListComplete(ctx context.Context) (result ImageListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ImagesClient) ListPreparer(ctx context.Context) (*http.Request, error)
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.
func (client ImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (Image, error)
}
func (future *ImagesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (OperationStatusResponse, error)
}
func (future *ImagesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
InnerError inner error details.
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"`
}
InstanceViewStatus instance view status.
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"`
}
InstanceViewTypes enumerates the values for instance view types.
type InstanceViewTypes string
const (
// InstanceView ...
InstanceView InstanceViewTypes = "instanceView"
)
func PossibleInstanceViewTypesValues() []InstanceViewTypes
PossibleInstanceViewTypesValues returns an array of possible values for the InstanceViewTypes const type.
KeyVaultAndKeyReference key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
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"`
}
KeyVaultAndSecretReference key Vault Secret Url and vault id of the encryption key
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"`
}
KeyVaultKeyReference describes a reference to Key Vault 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"`
}
KeyVaultSecretReference describes a reference to Key Vault Secret
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"`
}
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 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"`
}
ListUsagesResult the List Usages operation response.
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"`
}
func (lur ListUsagesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListUsagesResultIterator provides access to a complete listing of Usage values.
type ListUsagesResultIterator struct {
// contains filtered or unexported fields
}
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.
ListUsagesResultPage contains a page of Usage values.
type ListUsagesResultPage struct {
// contains filtered or unexported fields
}
func NewListUsagesResultPage(cur ListUsagesResult, getNextPage func(context.Context, ListUsagesResult) (ListUsagesResult, error)) ListUsagesResultPage
Creates a new instance of the ListUsagesResultPage type.
func (page *ListUsagesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListUsagesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListUsagesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListUsagesResultPage) Response() ListUsagesResult
Response returns the raw server response from the last page request.
func (page ListUsagesResultPage) Values() []Usage
Values returns the slice of values for the current page or nil if there are no values.
ListVirtualMachineExtensionImage ...
type ListVirtualMachineExtensionImage struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineExtensionImage `json:"value,omitempty"`
}
ListVirtualMachineImageResource ...
type ListVirtualMachineImageResource struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineImageResource `json:"value,omitempty"`
}
LongRunningOperationProperties compute-specific operation properties, including output
type LongRunningOperationProperties struct {
// Output - Operation output data (raw JSON)
Output interface{} `json:"output,omitempty"`
}
MaintenanceOperationResultCodeTypes enumerates the values for maintenance operation result code types.
type MaintenanceOperationResultCodeTypes string
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.
MaintenanceRedeployStatus maintenance Operation Status.
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"`
}
ManagedDiskParameters the parameters of a managed disk.
type ManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
NetworkInterfaceReference describes a network interface reference.
type NetworkInterfaceReference struct {
*NetworkInterfaceReferenceProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
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.
NetworkInterfaceReferenceProperties describes a network interface reference properties.
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"`
}
NetworkProfile specifies the network interfaces of the virtual machine.
type NetworkProfile struct {
// NetworkInterfaces - Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
NetworkInterfaces *[]NetworkInterfaceReference `json:"networkInterfaces,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 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"`
// 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"`
}
OSDiskImage contains the os disk image information.
type OSDiskImage struct {
// OperatingSystem - The operating system of the osDiskImage. Possible values include: 'Windows', 'Linux'
OperatingSystem OperatingSystemTypes `json:"operatingSystem,omitempty"`
}
OSProfile specifies the operating system settings for the virtual machine.
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"`
}
OperatingSystemStateTypes enumerates the values for operating system state types.
type OperatingSystemStateTypes string
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.
type OperatingSystemTypes string
const (
// Linux ...
Linux OperatingSystemTypes = "Linux"
// Windows ...
Windows OperatingSystemTypes = "Windows"
)
func PossibleOperatingSystemTypesValues() []OperatingSystemTypes
PossibleOperatingSystemTypesValues returns an array of possible values for the OperatingSystemTypes const type.
OperationStatusResponse operation status response
type OperationStatusResponse struct {
autorest.Response `json:"-"`
// Name - READ-ONLY; Operation ID
Name *string `json:"name,omitempty"`
// Status - READ-ONLY; Operation status
Status *string `json:"status,omitempty"`
// StartTime - READ-ONLY; Start time of the operation
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; End time of the operation
EndTime *date.Time `json:"endTime,omitempty"`
// Error - READ-ONLY; Api error
Error *APIError `json:"error,omitempty"`
}
func (osr OperationStatusResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationStatusResponse.
PassNames enumerates the values for pass names.
type PassNames string
const (
// OobeSystem ...
OobeSystem PassNames = "OobeSystem"
)
func PossiblePassNamesValues() []PassNames
PossiblePassNamesValues returns an array of possible values for the PassNames const type.
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**.
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"`
}
ProtocolTypes enumerates the values for protocol types.
type ProtocolTypes string
const (
// HTTP ...
HTTP ProtocolTypes = "Http"
// HTTPS ...
HTTPS ProtocolTypes = "Https"
)
func PossibleProtocolTypesValues() []ProtocolTypes
PossibleProtocolTypesValues returns an array of possible values for the ProtocolTypes const type.
PurchasePlan used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
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"`
}
Resource the Resource model definition.
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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// SystemAssigned ...
SystemAssigned ResourceIdentityType = "SystemAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
ResourceSku describes an available Compute SKU.
type ResourceSku struct {
// ResourceType - READ-ONLY; The type of resource the SKU applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Name - READ-ONLY; The name of SKU.
Name *string `json:"name,omitempty"`
// Tier - READ-ONLY; 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"`
// Size - READ-ONLY; The Size of the SKU.
Size *string `json:"size,omitempty"`
// Family - READ-ONLY; The Family of this particular SKU.
Family *string `json:"family,omitempty"`
// Kind - READ-ONLY; The Kind of resources that are supported in this SKU.
Kind *string `json:"kind,omitempty"`
// Capacity - READ-ONLY; Specifies the number of virtual machines in the scale set.
Capacity *ResourceSkuCapacity `json:"capacity,omitempty"`
// Locations - READ-ONLY; The set of locations that the SKU is available.
Locations *[]string `json:"locations,omitempty"`
// APIVersions - READ-ONLY; The api versions that support this SKU.
APIVersions *[]string `json:"apiVersions,omitempty"`
// Costs - READ-ONLY; Metadata for retrieving price info.
Costs *[]ResourceSkuCosts `json:"costs,omitempty"`
// Capabilities - READ-ONLY; A name value pair to describe the capability.
Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
// Restrictions - READ-ONLY; The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
}
func (rs ResourceSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSku.
ResourceSkuCapabilities describes The SKU capabilities object.
type ResourceSkuCapabilities struct {
// Name - READ-ONLY; An invariant to describe the feature.
Name *string `json:"name,omitempty"`
// Value - READ-ONLY; An invariant if the feature is measured by quantity.
Value *string `json:"value,omitempty"`
}
func (rsc ResourceSkuCapabilities) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCapabilities.
ResourceSkuCapacity describes scaling information of a SKU.
type ResourceSkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default capacity.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'ResourceSkuCapacityScaleTypeAutomatic', 'ResourceSkuCapacityScaleTypeManual', 'ResourceSkuCapacityScaleTypeNone'
ScaleType ResourceSkuCapacityScaleType `json:"scaleType,omitempty"`
}
func (rsc ResourceSkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCapacity.
ResourceSkuCapacityScaleType enumerates the values for resource sku capacity scale type.
type ResourceSkuCapacityScaleType string
const (
// ResourceSkuCapacityScaleTypeAutomatic ...
ResourceSkuCapacityScaleTypeAutomatic ResourceSkuCapacityScaleType = "Automatic"
// ResourceSkuCapacityScaleTypeManual ...
ResourceSkuCapacityScaleTypeManual ResourceSkuCapacityScaleType = "Manual"
// ResourceSkuCapacityScaleTypeNone ...
ResourceSkuCapacityScaleTypeNone ResourceSkuCapacityScaleType = "None"
)
func PossibleResourceSkuCapacityScaleTypeValues() []ResourceSkuCapacityScaleType
PossibleResourceSkuCapacityScaleTypeValues returns an array of possible values for the ResourceSkuCapacityScaleType const type.
ResourceSkuCosts describes metadata for retrieving price info.
type ResourceSkuCosts struct {
// MeterID - READ-ONLY; Used for querying price from commerce.
MeterID *string `json:"meterID,omitempty"`
// Quantity - READ-ONLY; The multiplier is needed to extend the base metered cost.
Quantity *int64 `json:"quantity,omitempty"`
// ExtendedUnit - READ-ONLY; An invariant to show the extended unit.
ExtendedUnit *string `json:"extendedUnit,omitempty"`
}
func (rsc ResourceSkuCosts) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCosts.
ResourceSkuRestrictions describes scaling information of a SKU.
type ResourceSkuRestrictions struct {
// Type - READ-ONLY; The type of restrictions. Possible values include: 'Location'
Type ResourceSkuRestrictionsType `json:"type,omitempty"`
// Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
Values *[]string `json:"values,omitempty"`
// ReasonCode - READ-ONLY; The reason for restriction. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
ReasonCode ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
}
func (rsr ResourceSkuRestrictions) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuRestrictions.
ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.
type ResourceSkuRestrictionsReasonCode string
const (
// NotAvailableForSubscription ...
NotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
// QuotaID ...
QuotaID ResourceSkuRestrictionsReasonCode = "QuotaId"
)
func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode
PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.
ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.
type ResourceSkuRestrictionsType string
const (
// Location ...
Location ResourceSkuRestrictionsType = "Location"
)
func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType
PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.
ResourceSkusClient is the compute Client
type ResourceSkusClient struct {
BaseClient
}
func NewResourceSkusClient(subscriptionID string) ResourceSkusClient
NewResourceSkusClient creates an instance of the ResourceSkusClient client.
func NewResourceSkusClientWithBaseURI(baseURI string, subscriptionID string) ResourceSkusClient
NewResourceSkusClientWithBaseURI creates an instance of the ResourceSkusClient 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 ResourceSkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)
List gets the list of Microsoft.Compute SKUs available for your Subscription.
func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ResourceSkusClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ResourceSkusClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ResourceSkusResult the Compute List Skus operation response.
type ResourceSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the subscription.
Value *[]ResourceSku `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next page of VMSS Skus.
NextLink *string `json:"nextLink,omitempty"`
}
func (rsr ResourceSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.
type ResourceSkusResultIterator struct {
// contains filtered or unexported fields
}
func NewResourceSkusResultIterator(page ResourceSkusResultPage) ResourceSkusResultIterator
Creates a new instance of the ResourceSkusResultIterator type.
func (iter *ResourceSkusResultIterator) 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 *ResourceSkusResultIterator) 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 ResourceSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceSkusResultIterator) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (iter ResourceSkusResultIterator) Value() ResourceSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ResourceSkusResultPage contains a page of ResourceSku values.
type ResourceSkusResultPage struct {
// contains filtered or unexported fields
}
func NewResourceSkusResultPage(cur ResourceSkusResult, getNextPage func(context.Context, ResourceSkusResult) (ResourceSkusResult, error)) ResourceSkusResultPage
Creates a new instance of the ResourceSkusResultPage type.
func (page *ResourceSkusResultPage) 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 *ResourceSkusResultPage) 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 ResourceSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceSkusResultPage) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (page ResourceSkusResultPage) Values() []ResourceSku
Values returns the slice of values for the current page or nil if there are no values.
ResourceUpdate the Resource model definition.
type ResourceUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}
func (ru ResourceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceUpdate.
RollingUpgradeActionType enumerates the values for rolling upgrade action type.
type RollingUpgradeActionType string
const (
// Cancel ...
Cancel RollingUpgradeActionType = "Cancel"
// Start ...
Start RollingUpgradeActionType = "Start"
)
func PossibleRollingUpgradeActionTypeValues() []RollingUpgradeActionType
PossibleRollingUpgradeActionTypeValues returns an array of possible values for the RollingUpgradeActionType const type.
RollingUpgradePolicy the configuration parameters used while performing a rolling upgrade.
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"`
}
RollingUpgradeProgressInfo information about the number of virtual machine instances in each upgrade state.
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"`
}
func (rupi RollingUpgradeProgressInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeProgressInfo.
RollingUpgradeRunningStatus information about the current running state of the overall upgrade.
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"`
}
func (rurs RollingUpgradeRunningStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeRunningStatus.
RollingUpgradeStatusCode enumerates the values for rolling upgrade status code.
type RollingUpgradeStatusCode string
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.
RollingUpgradeStatusInfo the status of the latest virtual machine scale set rolling upgrade.
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"`
}
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.
RollingUpgradeStatusInfoProperties the status of the latest virtual machine scale set rolling upgrade.
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"`
}
func (rusip RollingUpgradeStatusInfoProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeStatusInfoProperties.
RunCommandDocument describes the properties of a Run Command.
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"`
}
RunCommandDocumentBase describes the properties of a Run Command metadata.
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"`
}
RunCommandInput capture Virtual Machine parameters.
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"`
}
RunCommandInputParameter describes the properties of a run command parameter.
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"`
}
RunCommandListResult the List Virtual Machine operation response.
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"`
}
func (rclr RunCommandListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RunCommandListResultIterator provides access to a complete listing of RunCommandDocumentBase values.
type RunCommandListResultIterator struct {
// contains filtered or unexported fields
}
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.
RunCommandListResultPage contains a page of RunCommandDocumentBase values.
type RunCommandListResultPage struct {
// contains filtered or unexported fields
}
func NewRunCommandListResultPage(cur RunCommandListResult, 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.
RunCommandParameterDefinition describes the properties of a run command parameter.
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"`
}
RunCommandResult run command operation response.
type RunCommandResult struct {
autorest.Response `json:"-"`
*RunCommandResultProperties `json:"properties,omitempty"`
// Name - READ-ONLY; Operation ID
Name *string `json:"name,omitempty"`
// Status - READ-ONLY; Operation status
Status *string `json:"status,omitempty"`
// StartTime - READ-ONLY; Start time of the operation
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; End time of the operation
EndTime *date.Time `json:"endTime,omitempty"`
// Error - READ-ONLY; Api error
Error *APIError `json:"error,omitempty"`
}
func (rcr RunCommandResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RunCommandResult.
func (rcr *RunCommandResult) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RunCommandResult struct.
RunCommandResultProperties compute-specific operation properties, including output
type RunCommandResultProperties struct {
// Output - Operation output data (raw JSON)
Output interface{} `json:"output,omitempty"`
}
SSHConfiguration SSH configuration for Linux based VMs running on Azure
type SSHConfiguration struct {
// PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys *[]SSHPublicKey `json:"publicKeys,omitempty"`
}
SSHPublicKey contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
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"`
}
SettingNames enumerates the values for setting names.
type SettingNames string
const (
// AutoLogon ...
AutoLogon SettingNames = "AutoLogon"
// FirstLogonCommands ...
FirstLogonCommands SettingNames = "FirstLogonCommands"
)
func PossibleSettingNamesValues() []SettingNames
PossibleSettingNamesValues returns an array of possible values for the SettingNames const type.
Sku describes a virtual machine scale set sku.
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. 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.
Capacity *int64 `json:"capacity,omitempty"`
}
Snapshot snapshot resource.
type Snapshot struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; Unused. Always Null.
ManagedBy *string `json:"managedBy,omitempty"`
Sku *DiskSku `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"`
}
func (s Snapshot) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Snapshot.
func (s *Snapshot) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Snapshot struct.
SnapshotList the List Snapshots operation response.
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"`
}
func (sl SnapshotList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SnapshotListIterator provides access to a complete listing of Snapshot values.
type SnapshotListIterator struct {
// contains filtered or unexported fields
}
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.
SnapshotListPage contains a page of Snapshot values.
type SnapshotListPage struct {
// contains filtered or unexported fields
}
func NewSnapshotListPage(cur SnapshotList, 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.
SnapshotUpdate snapshot update resource.
type SnapshotUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}
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.
SnapshotsClient is the compute Client
type SnapshotsClient struct {
BaseClient
}
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 OperationStatusResponse, 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.
func (client SnapshotsClient) GetResponder(resp *http.Response) (result Snapshot, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SnapshotsClient) 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 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.
func (client SnapshotsClient) 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 SnapshotsClient) ListComplete(ctx context.Context) (result SnapshotListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SnapshotsClient) ListPreparer(ctx context.Context) (*http.Request, error)
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.
func (client SnapshotsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (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 OperationStatusResponse, 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.
func (client SnapshotsClient) UpdateResponder(resp *http.Response) (result Snapshot, err error)
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.
type SnapshotsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (Snapshot, error)
}
func (future *SnapshotsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (OperationStatusResponse, error)
}
func (future *SnapshotsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (AccessURI, error)
}
func (future *SnapshotsGrantAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (OperationStatusResponse, error)
}
func (future *SnapshotsRevokeAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (Snapshot, error)
}
func (future *SnapshotsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SourceVault the vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
type SourceVault struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
StatusLevelTypes enumerates the values for status level types.
type StatusLevelTypes string
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.
type StorageAccountTypes string
const (
// PremiumLRS ...
PremiumLRS StorageAccountTypes = "Premium_LRS"
// StandardLRS ...
StandardLRS StorageAccountTypes = "Standard_LRS"
)
func PossibleStorageAccountTypesValues() []StorageAccountTypes
PossibleStorageAccountTypesValues returns an array of possible values for the StorageAccountTypes const type.
StorageProfile specifies the storage settings for the virtual machine disks.
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"`
}
SubResource ...
type SubResource struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
SubResourceReadOnly ...
type SubResourceReadOnly struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (srro SubResourceReadOnly) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubResourceReadOnly.
UpdateResource the Update Resource model definition.
type UpdateResource struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (ur UpdateResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateResource.
UpgradeMode enumerates the values for upgrade mode.
type UpgradeMode string
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.
UpgradePolicy describes an upgrade policy - automatic, manual, or rolling.
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"`
}
Usage describes Compute Resource Usage.
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"`
}
UsageClient is the compute Client
type UsageClient struct {
BaseClient
}
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.
func (client UsageClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
UsageName the Usage Names.
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"`
}
VaultCertificate describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
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"`
}
VaultSecretGroup describes a set of certificates which are all in the same Key Vault.
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"`
}
VirtualHardDisk describes the uri of a disk.
type VirtualHardDisk struct {
// URI - Specifies the virtual hard disk's uri.
URI *string `json:"uri,omitempty"`
}
VirtualMachine describes a Virtual Machine.
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"`
}
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.
VirtualMachineAgentInstanceView the instance view of the VM Agent running on the virtual machine.
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"`
}
VirtualMachineCaptureParameters capture Virtual Machine parameters.
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"`
}
VirtualMachineCaptureResult resource Id.
type VirtualMachineCaptureResult struct {
autorest.Response `json:"-"`
*VirtualMachineCaptureResultProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmcr VirtualMachineCaptureResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineCaptureResult.
func (vmcr *VirtualMachineCaptureResult) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineCaptureResult struct.
VirtualMachineCaptureResultProperties compute-specific operation properties, including output
type VirtualMachineCaptureResultProperties struct {
// Output - Operation output data (raw JSON)
Output interface{} `json:"output,omitempty"`
}
VirtualMachineExtension describes a Virtual Machine Extension.
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"`
}
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.
VirtualMachineExtensionHandlerInstanceView the instance view of a virtual machine extension handler.
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"`
}
VirtualMachineExtensionImage describes a Virtual Machine Extension Image.
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"`
}
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.
VirtualMachineExtensionImageProperties describes the properties of a Virtual Machine Extension Image.
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"`
}
VirtualMachineExtensionImagesClient is the compute Client
type VirtualMachineExtensionImagesClient struct {
BaseClient
}
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.
VirtualMachineExtensionInstanceView the instance view of a virtual machine extension.
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"`
}
VirtualMachineExtensionProperties describes the properties 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"`
}
func (vmep VirtualMachineExtensionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionProperties.
VirtualMachineExtensionUpdate describes a Virtual Machine Extension.
type VirtualMachineExtensionUpdate struct {
*VirtualMachineExtensionUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
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.
VirtualMachineExtensionUpdateProperties describes the properties of a Virtual Machine Extension.
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"`
}
VirtualMachineExtensionsClient is the compute Client
type VirtualMachineExtensionsClient struct {
BaseClient
}
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 OperationStatusResponse, 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.
func (client VirtualMachineExtensionsClient) 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 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.
type VirtualMachineExtensionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (VirtualMachineExtension, error)
}
func (future *VirtualMachineExtensionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineExtensionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineExtensionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineExtensionsListResult the List Extension operation response
type VirtualMachineExtensionsListResult struct {
autorest.Response `json:"-"`
// Value - The list of extensions
Value *[]VirtualMachineExtension `json:"value,omitempty"`
}
VirtualMachineExtensionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineExtensionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (VirtualMachineExtension, error)
}
func (future *VirtualMachineExtensionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineHealthStatus the health status of the VM.
type VirtualMachineHealthStatus struct {
// Status - READ-ONLY; The health status information for the VM.
Status *InstanceViewStatus `json:"status,omitempty"`
}
func (vmhs VirtualMachineHealthStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineHealthStatus.
VirtualMachineIdentity identity for the virtual machine.
type VirtualMachineIdentity struct {
// PrincipalID - READ-ONLY; The principal id of virtual machine identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the virtual machine.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. Possible values include: 'SystemAssigned'
Type ResourceIdentityType `json:"type,omitempty"`
}
func (vmi VirtualMachineIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineIdentity.
VirtualMachineImage describes a Virtual Machine Image.
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"`
}
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.
VirtualMachineImageProperties describes the properties of a Virtual Machine Image.
type VirtualMachineImageProperties struct {
Plan *PurchasePlan `json:"plan,omitempty"`
OsDiskImage *OSDiskImage `json:"osDiskImage,omitempty"`
DataDiskImages *[]DataDiskImage `json:"dataDiskImages,omitempty"`
}
VirtualMachineImageResource virtual machine image resource information.
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"`
}
func (vmir VirtualMachineImageResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineImageResource.
VirtualMachineImagesClient is the compute Client
type VirtualMachineImagesClient struct {
BaseClient
}
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.
func (client VirtualMachineImagesClient) 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 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. skus - a valid image SKU. expand - the expand expression to apply on the operation.
func (client VirtualMachineImagesClient) ListOffers(ctx context.Context, location string, publisherName string) (result ListVirtualMachineImageResource, err error)
ListOffers gets a list of virtual machine image offers for the specified location and publisher. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher.
func (client VirtualMachineImagesClient) ListOffersPreparer(ctx context.Context, location string, publisherName string) (*http.Request, error)
ListOffersPreparer prepares the ListOffers request.
func (client VirtualMachineImagesClient) ListOffersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListOffersResponder handles the response to the ListOffers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListOffersSender(req *http.Request) (*http.Response, error)
ListOffersSender sends the ListOffers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListPreparer(ctx context.Context, location string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineImagesClient) ListPublishers(ctx context.Context, location string) (result ListVirtualMachineImageResource, err error)
ListPublishers gets a list of virtual machine image publishers for the specified Azure location. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineImagesClient) ListPublishersPreparer(ctx context.Context, location string) (*http.Request, error)
ListPublishersPreparer prepares the ListPublishers request.
func (client VirtualMachineImagesClient) ListPublishersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListPublishersResponder handles the response to the ListPublishers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListPublishersSender(req *http.Request) (*http.Response, error)
ListPublishersSender sends the ListPublishers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListSkus(ctx context.Context, location string, publisherName string, offer string) (result ListVirtualMachineImageResource, err error)
ListSkus gets a list of virtual machine image SKUs for the specified location, publisher, and offer. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer.
func (client VirtualMachineImagesClient) ListSkusPreparer(ctx context.Context, location string, publisherName string, offer string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (client VirtualMachineImagesClient) ListSkusResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListSkusSender(req *http.Request) (*http.Response, error)
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
VirtualMachineInstanceView the instance view of a virtual machine.
type VirtualMachineInstanceView struct {
autorest.Response `json:"-"`
// PlatformUpdateDomain - Specifies the update domain of the virtual machine.
PlatformUpdateDomain *int32 `json:"platformUpdateDomain,omitempty"`
// PlatformFaultDomain - Specifies the fault domain of the virtual machine.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// RdpThumbPrint - The Remote desktop certificate thumbprint.
RdpThumbPrint *string `json:"rdpThumbPrint,omitempty"`
// VMAgent - The VM Agent running on the virtual machine.
VMAgent *VirtualMachineAgentInstanceView `json:"vmAgent,omitempty"`
// MaintenanceRedeployStatus - The Maintenance Operation status on the virtual machine.
MaintenanceRedeployStatus *MaintenanceRedeployStatus `json:"maintenanceRedeployStatus,omitempty"`
// Disks - The virtual machine disk information.
Disks *[]DiskInstanceView `json:"disks,omitempty"`
// Extensions - The extensions information.
Extensions *[]VirtualMachineExtensionInstanceView `json:"extensions,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.
BootDiagnostics *BootDiagnosticsInstanceView `json:"bootDiagnostics,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
VirtualMachineListResult the List Virtual Machine operation response.
type VirtualMachineListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machines.
Value *[]VirtualMachine `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmlr VirtualMachineListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineListResultIterator provides access to a complete listing of VirtualMachine values.
type VirtualMachineListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineListResultIterator(page VirtualMachineListResultPage) VirtualMachineListResultIterator
Creates a new instance of the VirtualMachineListResultIterator type.
func (iter *VirtualMachineListResultIterator) 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 *VirtualMachineListResultIterator) 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 VirtualMachineListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineListResultIterator) Response() VirtualMachineListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineListResultIterator) Value() VirtualMachine
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineListResultPage contains a page of VirtualMachine values.
type VirtualMachineListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineListResultPage(cur VirtualMachineListResult, getNextPage func(context.Context, VirtualMachineListResult) (VirtualMachineListResult, error)) VirtualMachineListResultPage
Creates a new instance of the VirtualMachineListResultPage type.
func (page *VirtualMachineListResultPage) 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 *VirtualMachineListResultPage) 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 VirtualMachineListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineListResultPage) Response() VirtualMachineListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineListResultPage) Values() []VirtualMachine
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineProperties describes the properties of a Virtual Machine.
type VirtualMachineProperties struct {
// HardwareProfile - Specifies the hardware settings for the virtual machine.
HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *StorageProfile `json:"storageProfile,omitempty"`
// OsProfile - Specifies the operating system settings for the virtual machine.
OsProfile *OSProfile `json:"osProfile,omitempty"`
// NetworkProfile - Specifies the network interfaces of the virtual machine.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// 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.
AvailabilitySet *SubResource `json:"availabilitySet,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - READ-ONLY; The virtual machine instance view.
InstanceView *VirtualMachineInstanceView `json:"instanceView,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
// VMID - READ-ONLY; Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
VMID *string `json:"vmId,omitempty"`
}
func (vmp VirtualMachineProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineProperties.
VirtualMachineRunCommandsClient is the compute Client
type VirtualMachineRunCommandsClient struct {
BaseClient
}
func NewVirtualMachineRunCommandsClient(subscriptionID string) VirtualMachineRunCommandsClient
NewVirtualMachineRunCommandsClient creates an instance of the VirtualMachineRunCommandsClient client.
func NewVirtualMachineRunCommandsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineRunCommandsClient
NewVirtualMachineRunCommandsClientWithBaseURI creates an instance of the VirtualMachineRunCommandsClient 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 VirtualMachineRunCommandsClient) Get(ctx context.Context, location string, commandID string) (result RunCommandDocument, err error)
Get gets specific run command for a subscription in a location. Parameters: location - the location upon which run commands is queried. commandID - the command id.
func (client VirtualMachineRunCommandsClient) GetPreparer(ctx context.Context, location string, commandID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineRunCommandsClient) GetResponder(resp *http.Response) (result RunCommandDocument, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) 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 VirtualMachineRunCommandsClient) List(ctx context.Context, location string) (result RunCommandListResultPage, err error)
List lists all available run commands for a subscription in a location. Parameters: location - the location upon which run commands is queried.
func (client VirtualMachineRunCommandsClient) ListComplete(ctx context.Context, location string) (result RunCommandListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineRunCommandsClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineRunCommandsClient) ListResponder(resp *http.Response) (result RunCommandListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSet describes a Virtual Machine Scale Set.
type VirtualMachineScaleSet struct {
autorest.Response `json:"-"`
// Sku - The virtual machine scale set sku.
Sku *Sku `json:"sku,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**.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineScaleSetProperties `json:"properties,omitempty"`
// Identity - The identity of the virtual machine scale set, if configured.
Identity *VirtualMachineScaleSetIdentity `json:"identity,omitempty"`
// Zones - The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.
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"`
}
func (vmss VirtualMachineScaleSet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSet.
func (vmss *VirtualMachineScaleSet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSet struct.
VirtualMachineScaleSetDataDisk describes a virtual machine scale set data disk.
type VirtualMachineScaleSetDataDisk struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// 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"`
// 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"`
// CreateOption - The create option. 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 *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
}
VirtualMachineScaleSetExtension describes a Virtual Machine Scale Set Extension.
type VirtualMachineScaleSetExtension struct {
autorest.Response `json:"-"`
// Name - The name of the extension.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetExtensionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (vmsse VirtualMachineScaleSetExtension) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetExtension.
func (vmsse *VirtualMachineScaleSetExtension) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetExtension struct.
VirtualMachineScaleSetExtensionListResult the List VM scale set extension operation response.
type VirtualMachineScaleSetExtensionListResult struct {
autorest.Response `json:"-"`
// Value - The list of VM scale set extensions.
Value *[]VirtualMachineScaleSetExtension `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsselr VirtualMachineScaleSetExtensionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetExtensionListResultIterator provides access to a complete listing of VirtualMachineScaleSetExtension values.
type VirtualMachineScaleSetExtensionListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetExtensionListResultIterator(page VirtualMachineScaleSetExtensionListResultPage) VirtualMachineScaleSetExtensionListResultIterator
Creates a new instance of the VirtualMachineScaleSetExtensionListResultIterator type.
func (iter *VirtualMachineScaleSetExtensionListResultIterator) 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 *VirtualMachineScaleSetExtensionListResultIterator) 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 VirtualMachineScaleSetExtensionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetExtensionListResultIterator) Response() VirtualMachineScaleSetExtensionListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetExtensionListResultIterator) Value() VirtualMachineScaleSetExtension
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetExtensionListResultPage contains a page of VirtualMachineScaleSetExtension values.
type VirtualMachineScaleSetExtensionListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetExtensionListResultPage(cur VirtualMachineScaleSetExtensionListResult, getNextPage func(context.Context, VirtualMachineScaleSetExtensionListResult) (VirtualMachineScaleSetExtensionListResult, error)) VirtualMachineScaleSetExtensionListResultPage
Creates a new instance of the VirtualMachineScaleSetExtensionListResultPage type.
func (page *VirtualMachineScaleSetExtensionListResultPage) 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 *VirtualMachineScaleSetExtensionListResultPage) 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 VirtualMachineScaleSetExtensionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetExtensionListResultPage) Response() VirtualMachineScaleSetExtensionListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetExtensionListResultPage) Values() []VirtualMachineScaleSetExtension
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetExtensionProfile describes a virtual machine scale set extension profile.
type VirtualMachineScaleSetExtensionProfile struct {
// Extensions - The virtual machine scale set child extension resources.
Extensions *[]VirtualMachineScaleSetExtension `json:"extensions,omitempty"`
}
VirtualMachineScaleSetExtensionProperties describes the properties of a Virtual Machine Scale Set Extension.
type VirtualMachineScaleSetExtensionProperties struct {
// ForceUpdateTag - If a value is provided and is different from the previous value, the extension handler will 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"`
}
func (vmssep VirtualMachineScaleSetExtensionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetExtensionProperties.
VirtualMachineScaleSetExtensionsClient is the compute Client
type VirtualMachineScaleSetExtensionsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetExtensionsClient(subscriptionID string) VirtualMachineScaleSetExtensionsClient
NewVirtualMachineScaleSetExtensionsClient creates an instance of the VirtualMachineScaleSetExtensionsClient client.
func NewVirtualMachineScaleSetExtensionsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetExtensionsClient
NewVirtualMachineScaleSetExtensionsClientWithBaseURI creates an instance of the VirtualMachineScaleSetExtensionsClient 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 VirtualMachineScaleSetExtensionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtension) (result VirtualMachineScaleSetExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update an extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be create or updated. vmssExtensionName - the name of the VM scale set extension. extensionParameters - parameters supplied to the Create VM scale set Extension operation.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtension) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineScaleSetExtension, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string) (result VirtualMachineScaleSetExtensionsDeleteFuture, err error)
Delete the operation to delete the extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be deleted. vmssExtensionName - the name of the VM scale set extension.
func (client VirtualMachineScaleSetExtensionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetExtensionsClient) DeleteResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetExtensionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, expand string) (result VirtualMachineScaleSetExtension, err error)
Get the operation to get the extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set containing the extension. vmssExtensionName - the name of the VM scale set extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetExtensionsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetExtensionsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSetExtension, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) 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 VirtualMachineScaleSetExtensionsClient) List(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetExtensionListResultPage, err error)
List gets a list of all extensions in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set containing the extension.
func (client VirtualMachineScaleSetExtensionsClient) ListComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetExtensionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetExtensionsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetExtensionsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetExtensionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetExtensionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetExtensionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetExtensionsClient) (VirtualMachineScaleSetExtension, error)
}
func (future *VirtualMachineScaleSetExtensionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetExtensionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetExtensionsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetExtensionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetIPConfiguration describes a virtual machine scale set network profile's IP configuration.
type VirtualMachineScaleSetIPConfiguration struct {
// Name - The IP configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetIPConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssic VirtualMachineScaleSetIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetIPConfiguration.
func (vmssic *VirtualMachineScaleSetIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetIPConfiguration struct.
VirtualMachineScaleSetIPConfigurationProperties describes a virtual machine scale set network profile's IP configuration properties.
type VirtualMachineScaleSetIPConfigurationProperties struct {
// Subnet - Specifies the identifier of the subnet.
Subnet *APIEntityReference `json:"subnet,omitempty"`
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// PublicIPAddressConfiguration - The publicIPAddressConfiguration.
PublicIPAddressConfiguration *VirtualMachineScaleSetPublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'
PrivateIPAddressVersion IPVersion `json:"privateIPAddressVersion,omitempty"`
// ApplicationGatewayBackendAddressPools - Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.
ApplicationGatewayBackendAddressPools *[]SubResource `json:"applicationGatewayBackendAddressPools,omitempty"`
// LoadBalancerBackendAddressPools - Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
LoadBalancerBackendAddressPools *[]SubResource `json:"loadBalancerBackendAddressPools,omitempty"`
// LoadBalancerInboundNatPools - Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer
LoadBalancerInboundNatPools *[]SubResource `json:"loadBalancerInboundNatPools,omitempty"`
}
VirtualMachineScaleSetIdentity identity for the virtual machine scale set.
type VirtualMachineScaleSetIdentity struct {
// PrincipalID - READ-ONLY; The principal id of virtual machine scale set identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the virtual machine scale set.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. Possible values include: 'SystemAssigned'
Type ResourceIdentityType `json:"type,omitempty"`
}
func (vmssi VirtualMachineScaleSetIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetIdentity.
VirtualMachineScaleSetInstanceView the instance view of a virtual machine scale set.
type VirtualMachineScaleSetInstanceView struct {
autorest.Response `json:"-"`
// VirtualMachine - READ-ONLY; The instance view status summary for the virtual machine scale set.
VirtualMachine *VirtualMachineScaleSetInstanceViewStatusesSummary `json:"virtualMachine,omitempty"`
// Extensions - READ-ONLY; The extensions information.
Extensions *[]VirtualMachineScaleSetVMExtensionsSummary `json:"extensions,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
func (vmssiv VirtualMachineScaleSetInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetInstanceView.
VirtualMachineScaleSetInstanceViewStatusesSummary instance view statuses summary for virtual machines of a virtual machine scale set.
type VirtualMachineScaleSetInstanceViewStatusesSummary struct {
// StatusesSummary - READ-ONLY; The extensions information.
StatusesSummary *[]VirtualMachineStatusCodeCount `json:"statusesSummary,omitempty"`
}
func (vmssivss VirtualMachineScaleSetInstanceViewStatusesSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetInstanceViewStatusesSummary.
VirtualMachineScaleSetListResult the List Virtual Machine operation response.
type VirtualMachineScaleSetListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets.
Value *[]VirtualMachineScaleSet `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslr VirtualMachineScaleSetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListResultIterator provides access to a complete listing of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListResultIterator(page VirtualMachineScaleSetListResultPage) VirtualMachineScaleSetListResultIterator
Creates a new instance of the VirtualMachineScaleSetListResultIterator type.
func (iter *VirtualMachineScaleSetListResultIterator) 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 *VirtualMachineScaleSetListResultIterator) 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 VirtualMachineScaleSetListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListResultIterator) Response() VirtualMachineScaleSetListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListResultIterator) Value() VirtualMachineScaleSet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListResultPage contains a page of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListResultPage(cur VirtualMachineScaleSetListResult, getNextPage func(context.Context, VirtualMachineScaleSetListResult) (VirtualMachineScaleSetListResult, error)) VirtualMachineScaleSetListResultPage
Creates a new instance of the VirtualMachineScaleSetListResultPage type.
func (page *VirtualMachineScaleSetListResultPage) 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 *VirtualMachineScaleSetListResultPage) 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 VirtualMachineScaleSetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListResultPage) Response() VirtualMachineScaleSetListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListResultPage) Values() []VirtualMachineScaleSet
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetListSkusResult the Virtual Machine Scale Set List Skus operation response.
type VirtualMachineScaleSetListSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the virtual machine scale set.
Value *[]VirtualMachineScaleSetSku `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslsr VirtualMachineScaleSetListSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListSkusResultIterator provides access to a complete listing of VirtualMachineScaleSetSku values.
type VirtualMachineScaleSetListSkusResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListSkusResultIterator(page VirtualMachineScaleSetListSkusResultPage) VirtualMachineScaleSetListSkusResultIterator
Creates a new instance of the VirtualMachineScaleSetListSkusResultIterator type.
func (iter *VirtualMachineScaleSetListSkusResultIterator) 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 *VirtualMachineScaleSetListSkusResultIterator) 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 VirtualMachineScaleSetListSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListSkusResultIterator) Response() VirtualMachineScaleSetListSkusResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListSkusResultIterator) Value() VirtualMachineScaleSetSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListSkusResultPage contains a page of VirtualMachineScaleSetSku values.
type VirtualMachineScaleSetListSkusResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListSkusResultPage(cur VirtualMachineScaleSetListSkusResult, getNextPage func(context.Context, VirtualMachineScaleSetListSkusResult) (VirtualMachineScaleSetListSkusResult, error)) VirtualMachineScaleSetListSkusResultPage
Creates a new instance of the VirtualMachineScaleSetListSkusResultPage type.
func (page *VirtualMachineScaleSetListSkusResultPage) 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 *VirtualMachineScaleSetListSkusResultPage) 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 VirtualMachineScaleSetListSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListSkusResultPage) Response() VirtualMachineScaleSetListSkusResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListSkusResultPage) Values() []VirtualMachineScaleSetSku
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetListWithLinkResult the List Virtual Machine operation response.
type VirtualMachineScaleSetListWithLinkResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets.
Value *[]VirtualMachineScaleSet `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslwlr VirtualMachineScaleSetListWithLinkResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListWithLinkResultIterator provides access to a complete listing of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListWithLinkResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListWithLinkResultIterator(page VirtualMachineScaleSetListWithLinkResultPage) VirtualMachineScaleSetListWithLinkResultIterator
Creates a new instance of the VirtualMachineScaleSetListWithLinkResultIterator type.
func (iter *VirtualMachineScaleSetListWithLinkResultIterator) 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 *VirtualMachineScaleSetListWithLinkResultIterator) 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 VirtualMachineScaleSetListWithLinkResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListWithLinkResultIterator) Response() VirtualMachineScaleSetListWithLinkResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListWithLinkResultIterator) Value() VirtualMachineScaleSet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListWithLinkResultPage contains a page of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListWithLinkResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListWithLinkResultPage(cur VirtualMachineScaleSetListWithLinkResult, getNextPage func(context.Context, VirtualMachineScaleSetListWithLinkResult) (VirtualMachineScaleSetListWithLinkResult, error)) VirtualMachineScaleSetListWithLinkResultPage
Creates a new instance of the VirtualMachineScaleSetListWithLinkResultPage type.
func (page *VirtualMachineScaleSetListWithLinkResultPage) 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 *VirtualMachineScaleSetListWithLinkResultPage) 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 VirtualMachineScaleSetListWithLinkResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListWithLinkResultPage) Response() VirtualMachineScaleSetListWithLinkResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListWithLinkResultPage) Values() []VirtualMachineScaleSet
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetManagedDiskParameters describes the parameters of a ScaleSet managed disk.
type VirtualMachineScaleSetManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
}
VirtualMachineScaleSetNetworkConfiguration describes a virtual machine scale set network profile's network configurations.
type VirtualMachineScaleSetNetworkConfiguration struct {
// Name - The network configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetNetworkConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssnc VirtualMachineScaleSetNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetNetworkConfiguration.
func (vmssnc *VirtualMachineScaleSetNetworkConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetNetworkConfiguration struct.
VirtualMachineScaleSetNetworkConfigurationDNSSettings describes a virtual machines scale sets network configuration's DNS settings.
type VirtualMachineScaleSetNetworkConfigurationDNSSettings struct {
// DNSServers - List of DNS servers IP addresses
DNSServers *[]string `json:"dnsServers,omitempty"`
}
VirtualMachineScaleSetNetworkConfigurationProperties describes a virtual machine scale set network profile's IP configuration.
type VirtualMachineScaleSetNetworkConfigurationProperties struct {
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// EnableAcceleratedNetworking - Specifies whether the network interface is accelerated networking-enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// NetworkSecurityGroup - The network security group.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
// DNSSettings - The dns settings to be applied on the network interfaces.
DNSSettings *VirtualMachineScaleSetNetworkConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// IPConfigurations - Specifies the IP configurations of the network interface.
IPConfigurations *[]VirtualMachineScaleSetIPConfiguration `json:"ipConfigurations,omitempty"`
}
VirtualMachineScaleSetNetworkProfile describes a virtual machine scale set network profile.
type VirtualMachineScaleSetNetworkProfile struct {
// HealthProbe - A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
HealthProbe *APIEntityReference `json:"healthProbe,omitempty"`
// NetworkInterfaceConfigurations - The list of network configurations.
NetworkInterfaceConfigurations *[]VirtualMachineScaleSetNetworkConfiguration `json:"networkInterfaceConfigurations,omitempty"`
}
VirtualMachineScaleSetOSDisk describes a virtual machine scale set operating system disk.
type VirtualMachineScaleSetOSDisk struct {
// Name - The disk name.
Name *string `json:"name,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"`
// CreateOption - Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: **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"`
// 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"`
// Image - Specifies information about the unmanaged user image to base the scale set on.
Image *VirtualHardDisk `json:"image,omitempty"`
// VhdContainers - Specifies the container urls that are used to store operating system disks for the scale set.
VhdContainers *[]string `json:"vhdContainers,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
}
VirtualMachineScaleSetOSProfile describes a virtual machine scale set OS profile.
type VirtualMachineScaleSetOSProfile struct {
// ComputerNamePrefix - Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
ComputerNamePrefix *string `json:"computerNamePrefix,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 machines in the scale set.
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
}
VirtualMachineScaleSetProperties describes the properties of a Virtual Machine Scale Set.
type VirtualMachineScaleSetProperties struct {
// UpgradePolicy - The upgrade policy.
UpgradePolicy *UpgradePolicy `json:"upgradePolicy,omitempty"`
// VirtualMachineProfile - The virtual machine profile.
VirtualMachineProfile *VirtualMachineScaleSetVMProfile `json:"virtualMachineProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Overprovision - Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Overprovision *bool `json:"overprovision,omitempty"`
// UniqueID - READ-ONLY; Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
UniqueID *string `json:"uniqueId,omitempty"`
// SinglePlacementGroup - When true this limits the scale set to a single placement group, of max size 100 virtual machines.
SinglePlacementGroup *bool `json:"singlePlacementGroup,omitempty"`
}
func (vmssp VirtualMachineScaleSetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetProperties.
VirtualMachineScaleSetPublicIPAddressConfiguration describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetPublicIPAddressConfiguration struct {
// Name - The publicIP address configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetPublicIPAddressConfigurationProperties `json:"properties,omitempty"`
}
func (vmsspiac VirtualMachineScaleSetPublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetPublicIPAddressConfiguration.
func (vmsspiac *VirtualMachineScaleSetPublicIPAddressConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetPublicIPAddressConfiguration struct.
VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings describes a virtual machines scale sets network configuration's DNS settings.
type VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings struct {
// DomainNameLabel - The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created
DomainNameLabel *string `json:"domainNameLabel,omitempty"`
}
VirtualMachineScaleSetPublicIPAddressConfigurationProperties describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetPublicIPAddressConfigurationProperties struct {
// IdleTimeoutInMinutes - The idle timeout of the public IP address.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// DNSSettings - The dns settings to be applied on the publicIP addresses .
DNSSettings *VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings `json:"dnsSettings,omitempty"`
}
VirtualMachineScaleSetRollingUpgradesCancelFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetRollingUpgradesCancelFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetRollingUpgradesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetRollingUpgradesCancelFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetRollingUpgradesClient is the compute Client
type VirtualMachineScaleSetRollingUpgradesClient struct {
BaseClient
}
func NewVirtualMachineScaleSetRollingUpgradesClient(subscriptionID string) VirtualMachineScaleSetRollingUpgradesClient
NewVirtualMachineScaleSetRollingUpgradesClient creates an instance of the VirtualMachineScaleSetRollingUpgradesClient client.
func NewVirtualMachineScaleSetRollingUpgradesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetRollingUpgradesClient
NewVirtualMachineScaleSetRollingUpgradesClientWithBaseURI creates an instance of the VirtualMachineScaleSetRollingUpgradesClient 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 VirtualMachineScaleSetRollingUpgradesClient) Cancel(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetRollingUpgradesCancelFuture, err error)
Cancel cancels the current virtual machine scale set rolling upgrade. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelResponder(resp *http.Response) (result OperationStatusResponse, err error)
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelSender(req *http.Request) (future VirtualMachineScaleSetRollingUpgradesCancelFuture, err error)
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatest(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result RollingUpgradeStatusInfo, err error)
GetLatest gets the status of the latest virtual machine scale set rolling upgrade. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetLatestPreparer prepares the GetLatest request.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestResponder(resp *http.Response) (result RollingUpgradeStatusInfo, err error)
GetLatestResponder handles the response to the GetLatest request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestSender(req *http.Request) (*http.Response, error)
GetLatestSender sends the GetLatest request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgrade(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture, err error)
StartOSUpgrade starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
StartOSUpgradePreparer prepares the StartOSUpgrade request.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradeResponder(resp *http.Response) (result OperationStatusResponse, err error)
StartOSUpgradeResponder handles the response to the StartOSUpgrade request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradeSender(req *http.Request) (future VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture, err error)
StartOSUpgradeSender sends the StartOSUpgrade request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetRollingUpgradesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetSku describes an available virtual machine scale set sku.
type VirtualMachineScaleSetSku struct {
// ResourceType - READ-ONLY; The type of resource the sku applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Sku - READ-ONLY; The Sku.
Sku *Sku `json:"sku,omitempty"`
// Capacity - READ-ONLY; Specifies the number of virtual machines in the scale set.
Capacity *VirtualMachineScaleSetSkuCapacity `json:"capacity,omitempty"`
}
func (vmsss VirtualMachineScaleSetSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetSku.
VirtualMachineScaleSetSkuCapacity describes scaling information of a sku.
type VirtualMachineScaleSetSkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// DefaultCapacity - READ-ONLY; The default capacity.
DefaultCapacity *int64 `json:"defaultCapacity,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'VirtualMachineScaleSetSkuScaleTypeAutomatic', 'VirtualMachineScaleSetSkuScaleTypeNone'
ScaleType VirtualMachineScaleSetSkuScaleType `json:"scaleType,omitempty"`
}
func (vmsssc VirtualMachineScaleSetSkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetSkuCapacity.
VirtualMachineScaleSetSkuScaleType enumerates the values for virtual machine scale set sku scale type.
type VirtualMachineScaleSetSkuScaleType string
const (
// VirtualMachineScaleSetSkuScaleTypeAutomatic ...
VirtualMachineScaleSetSkuScaleTypeAutomatic VirtualMachineScaleSetSkuScaleType = "Automatic"
// VirtualMachineScaleSetSkuScaleTypeNone ...
VirtualMachineScaleSetSkuScaleTypeNone VirtualMachineScaleSetSkuScaleType = "None"
)
func PossibleVirtualMachineScaleSetSkuScaleTypeValues() []VirtualMachineScaleSetSkuScaleType
PossibleVirtualMachineScaleSetSkuScaleTypeValues returns an array of possible values for the VirtualMachineScaleSetSkuScaleType const type.
VirtualMachineScaleSetStorageProfile describes a virtual machine scale set storage profile.
type VirtualMachineScaleSetStorageProfile 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 machines in the scale set. <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 *VirtualMachineScaleSetOSDisk `json:"osDisk,omitempty"`
// DataDisks - Specifies the parameters that are used to add data disks to the virtual machines in the scale set. <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 *[]VirtualMachineScaleSetDataDisk `json:"dataDisks,omitempty"`
}
VirtualMachineScaleSetUpdate describes a Virtual Machine Scale Set.
type VirtualMachineScaleSetUpdate struct {
// Sku - The virtual machine scale set sku.
Sku *Sku `json:"sku,omitempty"`
// Plan - The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineScaleSetUpdateProperties `json:"properties,omitempty"`
// Identity - The identity of the virtual machine scale set, if configured.
Identity *VirtualMachineScaleSetIdentity `json:"identity,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmssu VirtualMachineScaleSetUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdate.
func (vmssu *VirtualMachineScaleSetUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdate struct.
VirtualMachineScaleSetUpdateIPConfiguration describes a virtual machine scale set network profile's IP configuration.
type VirtualMachineScaleSetUpdateIPConfiguration struct {
// Name - The IP configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdateIPConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssuic VirtualMachineScaleSetUpdateIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdateIPConfiguration.
func (vmssuic *VirtualMachineScaleSetUpdateIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdateIPConfiguration struct.
VirtualMachineScaleSetUpdateIPConfigurationProperties describes a virtual machine scale set network profile's IP configuration properties. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network.
type VirtualMachineScaleSetUpdateIPConfigurationProperties struct {
// Subnet - The subnet.
Subnet *APIEntityReference `json:"subnet,omitempty"`
// Primary - Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
Primary *bool `json:"primary,omitempty"`
// PublicIPAddressConfiguration - The publicIPAddressConfiguration.
PublicIPAddressConfiguration *VirtualMachineScaleSetUpdatePublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6'
PrivateIPAddressVersion IPVersion `json:"privateIPAddressVersion,omitempty"`
// ApplicationGatewayBackendAddressPools - The application gateway backend address pools.
ApplicationGatewayBackendAddressPools *[]SubResource `json:"applicationGatewayBackendAddressPools,omitempty"`
// LoadBalancerBackendAddressPools - The load balancer backend address pools.
LoadBalancerBackendAddressPools *[]SubResource `json:"loadBalancerBackendAddressPools,omitempty"`
// LoadBalancerInboundNatPools - The load balancer inbound nat pools.
LoadBalancerInboundNatPools *[]SubResource `json:"loadBalancerInboundNatPools,omitempty"`
}
VirtualMachineScaleSetUpdateNetworkConfiguration describes a virtual machine scale set network profile's network configurations.
type VirtualMachineScaleSetUpdateNetworkConfiguration struct {
// Name - The network configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdateNetworkConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssunc VirtualMachineScaleSetUpdateNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdateNetworkConfiguration.
func (vmssunc *VirtualMachineScaleSetUpdateNetworkConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdateNetworkConfiguration struct.
VirtualMachineScaleSetUpdateNetworkConfigurationProperties describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration.
type VirtualMachineScaleSetUpdateNetworkConfigurationProperties struct {
// Primary - Whether this is a primary NIC on a virtual machine.
Primary *bool `json:"primary,omitempty"`
// EnableAcceleratedNetworking - Specifies whether the network interface is accelerated networking-enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// NetworkSecurityGroup - The network security group.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
// DNSSettings - The dns settings to be applied on the network interfaces.
DNSSettings *VirtualMachineScaleSetNetworkConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// IPConfigurations - The virtual machine scale set IP Configuration.
IPConfigurations *[]VirtualMachineScaleSetUpdateIPConfiguration `json:"ipConfigurations,omitempty"`
}
VirtualMachineScaleSetUpdateNetworkProfile describes a virtual machine scale set network profile.
type VirtualMachineScaleSetUpdateNetworkProfile struct {
// NetworkInterfaceConfigurations - The list of network configurations.
NetworkInterfaceConfigurations *[]VirtualMachineScaleSetUpdateNetworkConfiguration `json:"networkInterfaceConfigurations,omitempty"`
}
VirtualMachineScaleSetUpdateOSDisk describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
type VirtualMachineScaleSetUpdateOSDisk struct {
// Caching - The caching type. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// Image - The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// VhdContainers - The list of virtual hard disk container uris.
VhdContainers *[]string `json:"vhdContainers,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
}
VirtualMachineScaleSetUpdateOSProfile describes a virtual machine scale set OS profile.
type VirtualMachineScaleSetUpdateOSProfile struct {
// CustomData - A base-64 encoded string of custom data.
CustomData *string `json:"customData,omitempty"`
// WindowsConfiguration - The Windows Configuration of the OS profile.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// LinuxConfiguration - The Linux Configuration of the OS profile.
LinuxConfiguration *LinuxConfiguration `json:"linuxConfiguration,omitempty"`
// Secrets - The List of certificates for addition to the VM.
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
}
VirtualMachineScaleSetUpdateProperties describes the properties of a Virtual Machine Scale Set.
type VirtualMachineScaleSetUpdateProperties struct {
// UpgradePolicy - The upgrade policy.
UpgradePolicy *UpgradePolicy `json:"upgradePolicy,omitempty"`
// VirtualMachineProfile - The virtual machine profile.
VirtualMachineProfile *VirtualMachineScaleSetUpdateVMProfile `json:"virtualMachineProfile,omitempty"`
// Overprovision - Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Overprovision *bool `json:"overprovision,omitempty"`
// SinglePlacementGroup - When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
SinglePlacementGroup *bool `json:"singlePlacementGroup,omitempty"`
}
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetUpdatePublicIPAddressConfiguration struct {
// Name - The publicIP address configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties `json:"properties,omitempty"`
}
func (vmssupiac VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdatePublicIPAddressConfiguration.
func (vmssupiac *VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdatePublicIPAddressConfiguration struct.
VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties struct {
// IdleTimeoutInMinutes - The idle timeout of the public IP address.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// DNSSettings - The dns settings to be applied on the publicIP addresses .
DNSSettings *VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings `json:"dnsSettings,omitempty"`
}
VirtualMachineScaleSetUpdateStorageProfile describes a virtual machine scale set storage profile.
type VirtualMachineScaleSetUpdateStorageProfile struct {
// ImageReference - The image reference.
ImageReference *ImageReference `json:"imageReference,omitempty"`
// OsDisk - The OS disk.
OsDisk *VirtualMachineScaleSetUpdateOSDisk `json:"osDisk,omitempty"`
// DataDisks - The data disks.
DataDisks *[]VirtualMachineScaleSetDataDisk `json:"dataDisks,omitempty"`
}
VirtualMachineScaleSetUpdateVMProfile describes a virtual machine scale set virtual machine profile.
type VirtualMachineScaleSetUpdateVMProfile struct {
// OsProfile - The virtual machine scale set OS profile.
OsProfile *VirtualMachineScaleSetUpdateOSProfile `json:"osProfile,omitempty"`
// StorageProfile - The virtual machine scale set storage profile.
StorageProfile *VirtualMachineScaleSetUpdateStorageProfile `json:"storageProfile,omitempty"`
// NetworkProfile - The virtual machine scale set network profile.
NetworkProfile *VirtualMachineScaleSetUpdateNetworkProfile `json:"networkProfile,omitempty"`
// DiagnosticsProfile - The virtual machine scale set diagnostics profile.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// ExtensionProfile - The virtual machine scale set extension profile.
ExtensionProfile *VirtualMachineScaleSetExtensionProfile `json:"extensionProfile,omitempty"`
// LicenseType - The license type, which is for bring your own license scenario.
LicenseType *string `json:"licenseType,omitempty"`
}
VirtualMachineScaleSetVM describes a virtual machine scale set virtual machine.
type VirtualMachineScaleSetVM struct {
autorest.Response `json:"-"`
// InstanceID - READ-ONLY; The virtual machine instance ID.
InstanceID *string `json:"instanceId,omitempty"`
// Sku - READ-ONLY; The virtual machine SKU.
Sku *Sku `json:"sku,omitempty"`
*VirtualMachineScaleSetVMProperties `json:"properties,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**.
Plan *Plan `json:"plan,omitempty"`
// Resources - READ-ONLY; The virtual machine child extension resources.
Resources *[]VirtualMachineExtension `json:"resources,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"`
}
func (vmssv VirtualMachineScaleSetVM) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVM.
func (vmssv *VirtualMachineScaleSetVM) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetVM struct.
VirtualMachineScaleSetVMExtensionsSummary extensions summary for virtual machines of a virtual machine scale set.
type VirtualMachineScaleSetVMExtensionsSummary struct {
// Name - READ-ONLY; The extension name.
Name *string `json:"name,omitempty"`
// StatusesSummary - READ-ONLY; The extensions information.
StatusesSummary *[]VirtualMachineStatusCodeCount `json:"statusesSummary,omitempty"`
}
func (vmssves VirtualMachineScaleSetVMExtensionsSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMExtensionsSummary.
VirtualMachineScaleSetVMInstanceIDs specifies a list of virtual machine instance IDs from the VM scale set.
type VirtualMachineScaleSetVMInstanceIDs struct {
// InstanceIds - The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
InstanceIds *[]string `json:"instanceIds,omitempty"`
}
VirtualMachineScaleSetVMInstanceRequiredIDs specifies a list of virtual machine instance IDs from the VM scale set.
type VirtualMachineScaleSetVMInstanceRequiredIDs struct {
// InstanceIds - The virtual machine scale set instance ids.
InstanceIds *[]string `json:"instanceIds,omitempty"`
}
VirtualMachineScaleSetVMInstanceView the instance view of a virtual machine scale set VM.
type VirtualMachineScaleSetVMInstanceView struct {
autorest.Response `json:"-"`
// PlatformUpdateDomain - The Update Domain count.
PlatformUpdateDomain *int32 `json:"platformUpdateDomain,omitempty"`
// PlatformFaultDomain - The Fault Domain count.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// RdpThumbPrint - The Remote desktop certificate thumbprint.
RdpThumbPrint *string `json:"rdpThumbPrint,omitempty"`
// VMAgent - The VM Agent running on the virtual machine.
VMAgent *VirtualMachineAgentInstanceView `json:"vmAgent,omitempty"`
// Disks - The disks information.
Disks *[]DiskInstanceView `json:"disks,omitempty"`
// Extensions - The extensions information.
Extensions *[]VirtualMachineExtensionInstanceView `json:"extensions,omitempty"`
// VMHealth - READ-ONLY; The health status for the VM.
VMHealth *VirtualMachineHealthStatus `json:"vmHealth,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.
BootDiagnostics *BootDiagnosticsInstanceView `json:"bootDiagnostics,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
// PlacementGroupID - The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
PlacementGroupID *string `json:"placementGroupId,omitempty"`
}
func (vmssviv VirtualMachineScaleSetVMInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMInstanceView.
VirtualMachineScaleSetVMListResult the List Virtual Machine Scale Set VMs operation response.
type VirtualMachineScaleSetVMListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets VMs.
Value *[]VirtualMachineScaleSetVM `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs
NextLink *string `json:"nextLink,omitempty"`
}
func (vmssvlr VirtualMachineScaleSetVMListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetVMListResultIterator provides access to a complete listing of VirtualMachineScaleSetVM values.
type VirtualMachineScaleSetVMListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetVMListResultIterator(page VirtualMachineScaleSetVMListResultPage) VirtualMachineScaleSetVMListResultIterator
Creates a new instance of the VirtualMachineScaleSetVMListResultIterator type.
func (iter *VirtualMachineScaleSetVMListResultIterator) 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 *VirtualMachineScaleSetVMListResultIterator) 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 VirtualMachineScaleSetVMListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetVMListResultIterator) Response() VirtualMachineScaleSetVMListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetVMListResultIterator) Value() VirtualMachineScaleSetVM
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetVMListResultPage contains a page of VirtualMachineScaleSetVM values.
type VirtualMachineScaleSetVMListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetVMListResultPage(cur VirtualMachineScaleSetVMListResult, getNextPage func(context.Context, VirtualMachineScaleSetVMListResult) (VirtualMachineScaleSetVMListResult, error)) VirtualMachineScaleSetVMListResultPage
Creates a new instance of the VirtualMachineScaleSetVMListResultPage type.
func (page *VirtualMachineScaleSetVMListResultPage) 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 *VirtualMachineScaleSetVMListResultPage) 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 VirtualMachineScaleSetVMListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetVMListResultPage) Response() VirtualMachineScaleSetVMListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetVMListResultPage) Values() []VirtualMachineScaleSetVM
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetVMProfile describes a virtual machine scale set virtual machine profile.
type VirtualMachineScaleSetVMProfile struct {
// OsProfile - Specifies the operating system settings for the virtual machines in the scale set.
OsProfile *VirtualMachineScaleSetOSProfile `json:"osProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *VirtualMachineScaleSetStorageProfile `json:"storageProfile,omitempty"`
// NetworkProfile - Specifies properties of the network interfaces of the virtual machines in the scale set.
NetworkProfile *VirtualMachineScaleSetNetworkProfile `json:"networkProfile,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// ExtensionProfile - Specifies a collection of settings for extensions installed on virtual machines in the scale set.
ExtensionProfile *VirtualMachineScaleSetExtensionProfile `json:"extensionProfile,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
}
VirtualMachineScaleSetVMProperties describes the properties of a virtual machine scale set virtual machine.
type VirtualMachineScaleSetVMProperties struct {
// LatestModelApplied - READ-ONLY; Specifies whether the latest model has been applied to the virtual machine.
LatestModelApplied *bool `json:"latestModelApplied,omitempty"`
// VMID - READ-ONLY; Azure VM unique ID.
VMID *string `json:"vmId,omitempty"`
// InstanceView - READ-ONLY; The virtual machine instance view.
InstanceView *VirtualMachineScaleSetVMInstanceView `json:"instanceView,omitempty"`
// HardwareProfile - Specifies the hardware settings for the virtual machine.
HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *StorageProfile `json:"storageProfile,omitempty"`
// OsProfile - Specifies the operating system settings for the virtual machine.
OsProfile *OSProfile `json:"osProfile,omitempty"`
// NetworkProfile - Specifies the network interfaces of the virtual machine.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// 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.
AvailabilitySet *SubResource `json:"availabilitySet,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
}
func (vmssvp VirtualMachineScaleSetVMProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMProperties.
VirtualMachineScaleSetVMsClient is the compute Client
type VirtualMachineScaleSetVMsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetVMsClient(subscriptionID string) VirtualMachineScaleSetVMsClient
NewVirtualMachineScaleSetVMsClient creates an instance of the VirtualMachineScaleSetVMsClient client.
func NewVirtualMachineScaleSetVMsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetVMsClient
NewVirtualMachineScaleSetVMsClientWithBaseURI creates an instance of the VirtualMachineScaleSetVMsClient 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 VirtualMachineScaleSetVMsClient) Deallocate(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsDeallocateFuture, err error)
Deallocate deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachineScaleSetVMsClient) DeallocateResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) DeallocateSender(req *http.Request) (future VirtualMachineScaleSetVMsDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsDeleteFuture, err error)
Delete deletes a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetVMsClient) DeleteResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetVMsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVM, err error)
Get gets a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) GetInstanceView(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMInstanceView, err error)
GetInstanceView gets the status of a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewResponder(resp *http.Response) (result VirtualMachineScaleSetVMInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetVMsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSetVM, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) 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 VirtualMachineScaleSetVMsClient) List(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (result VirtualMachineScaleSetVMListResultPage, err error)
List gets a list of all virtual machines in a VM scale sets. Parameters: resourceGroupName - the name of the resource group. virtualMachineScaleSetName - the name of the VM scale set. filter - the filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'. selectParameter - the list parameters. Allowed values are 'instanceView', 'instanceView/statuses'. expand - the expand expression to apply to the operation. Allowed values are 'instanceView'.
func (client VirtualMachineScaleSetVMsClient) ListComplete(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (result VirtualMachineScaleSetVMListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetVMsClient) ListPreparer(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetVMsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetVMListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) PowerOff(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsPowerOffFuture, err error)
PowerOff power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachineScaleSetVMsClient) PowerOffResponder(resp *http.Response) (result OperationStatusResponse, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) PowerOffSender(req *http.Request) (future VirtualMachineScaleSetVMsPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Reimage(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsReimageFuture, err error)
Reimage reimages (upgrade the operating system) a specific virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) ReimageAll(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsReimageAllFuture, err error)
ReimageAll allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) ReimageAllPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
ReimageAllPreparer prepares the ReimageAll request.
func (client VirtualMachineScaleSetVMsClient) ReimageAllResponder(resp *http.Response) (result OperationStatusResponse, err error)
ReimageAllResponder handles the response to the ReimageAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ReimageAllSender(req *http.Request) (future VirtualMachineScaleSetVMsReimageAllFuture, err error)
ReimageAllSender sends the ReimageAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) ReimagePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client VirtualMachineScaleSetVMsClient) ReimageResponder(resp *http.Response) (result OperationStatusResponse, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ReimageSender(req *http.Request) (future VirtualMachineScaleSetVMsReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Restart(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsRestartFuture, err error)
Restart restarts a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachineScaleSetVMsClient) RestartResponder(resp *http.Response) (result OperationStatusResponse, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) RestartSender(req *http.Request) (future VirtualMachineScaleSetVMsRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Start(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsStartFuture, err error)
Start starts a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) StartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachineScaleSetVMsClient) StartResponder(resp *http.Response) (result OperationStatusResponse, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) StartSender(req *http.Request) (future VirtualMachineScaleSetVMsStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetVMsDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsReimageAllFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsReimageAllFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsReimageAllFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetVMsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsClient is the compute Client
type VirtualMachineScaleSetsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetsClient(subscriptionID string) VirtualMachineScaleSetsClient
NewVirtualMachineScaleSetsClient creates an instance of the VirtualMachineScaleSetsClient client.
func NewVirtualMachineScaleSetsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetsClient
NewVirtualMachineScaleSetsClientWithBaseURI creates an instance of the VirtualMachineScaleSetsClient 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 VirtualMachineScaleSetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSet) (result VirtualMachineScaleSetsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set to create or update. parameters - the scale set object.
func (client VirtualMachineScaleSetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Deallocate(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsDeallocateFuture, err error)
Deallocate deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachineScaleSetsClient) DeallocateResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) DeallocateSender(req *http.Request) (future VirtualMachineScaleSetsDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetsDeleteFuture, err error)
Delete deletes a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) DeleteInstances(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (result VirtualMachineScaleSetsDeleteInstancesFuture, err error)
DeleteInstances deletes virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) DeleteInstancesPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (*http.Request, error)
DeleteInstancesPreparer prepares the DeleteInstances request.
func (client VirtualMachineScaleSetsClient) DeleteInstancesResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeleteInstancesResponder handles the response to the DeleteInstances request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) DeleteInstancesSender(req *http.Request) (future VirtualMachineScaleSetsDeleteInstancesFuture, err error)
DeleteInstancesSender sends the DeleteInstances request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetsClient) DeleteResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSet, err error)
Get display information about a virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) GetInstanceView(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetInstanceView, err error)
GetInstanceView gets the status of a VM scale set instance. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) GetInstanceViewPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client VirtualMachineScaleSetsClient) GetInstanceViewResponder(resp *http.Response) (result VirtualMachineScaleSetInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) 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 VirtualMachineScaleSetsClient) List(ctx context.Context, resourceGroupName string) (result VirtualMachineScaleSetListResultPage, err error)
List gets a list of all VM scale sets under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client VirtualMachineScaleSetsClient) ListAll(ctx context.Context) (result VirtualMachineScaleSetListWithLinkResultPage, err error)
ListAll gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
func (client VirtualMachineScaleSetsClient) ListAllComplete(ctx context.Context) (result VirtualMachineScaleSetListWithLinkResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client VirtualMachineScaleSetsClient) ListAllResponder(resp *http.Response) (result VirtualMachineScaleSetListWithLinkResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result VirtualMachineScaleSetListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ListSkus(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListSkusResultPage, err error)
ListSkus gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) ListSkusComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListSkusResultIterator, err error)
ListSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListSkusPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (client VirtualMachineScaleSetsClient) ListSkusResponder(resp *http.Response) (result VirtualMachineScaleSetListSkusResult, err error)
ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListSkusSender(req *http.Request) (*http.Response, error)
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) PowerOff(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsPowerOffFuture, err error)
PowerOff power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachineScaleSetsClient) PowerOffResponder(resp *http.Response) (result OperationStatusResponse, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) PowerOffSender(req *http.Request) (future VirtualMachineScaleSetsPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Reimage(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsReimageFuture, err error)
Reimage reimages (upgrade the operating system) one or more virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) ReimageAll(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsReimageAllFuture, err error)
ReimageAll reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) ReimageAllPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
ReimageAllPreparer prepares the ReimageAll request.
func (client VirtualMachineScaleSetsClient) ReimageAllResponder(resp *http.Response) (result OperationStatusResponse, err error)
ReimageAllResponder handles the response to the ReimageAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ReimageAllSender(req *http.Request) (future VirtualMachineScaleSetsReimageAllFuture, err error)
ReimageAllSender sends the ReimageAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ReimagePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client VirtualMachineScaleSetsClient) ReimageResponder(resp *http.Response) (result OperationStatusResponse, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ReimageSender(req *http.Request) (future VirtualMachineScaleSetsReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Restart(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsRestartFuture, err error)
Restart restarts one or more virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachineScaleSetsClient) RestartResponder(resp *http.Response) (result OperationStatusResponse, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) RestartSender(req *http.Request) (future VirtualMachineScaleSetsRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Start(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsStartFuture, err error)
Start starts one or more virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) StartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachineScaleSetsClient) StartResponder(resp *http.Response) (result OperationStatusResponse, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) StartSender(req *http.Request) (future VirtualMachineScaleSetsStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSetUpdate) (result VirtualMachineScaleSetsUpdateFuture, err error)
Update update a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set to create or update. parameters - the scale set object.
func (client VirtualMachineScaleSetsClient) UpdateInstances(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (result VirtualMachineScaleSetsUpdateInstancesFuture, err error)
UpdateInstances upgrades one or more virtual machines to the latest SKU set in the VM scale set model. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) UpdateInstancesPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (*http.Request, error)
UpdateInstancesPreparer prepares the UpdateInstances request.
func (client VirtualMachineScaleSetsClient) UpdateInstancesResponder(resp *http.Response) (result OperationStatusResponse, err error)
UpdateInstancesResponder handles the response to the UpdateInstances request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) UpdateInstancesSender(req *http.Request) (future VirtualMachineScaleSetsUpdateInstancesFuture, err error)
UpdateInstancesSender sends the UpdateInstances request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSetUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetsClient) UpdateResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (VirtualMachineScaleSet, error)
}
func (future *VirtualMachineScaleSetsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeleteInstancesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeleteInstancesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsDeleteInstancesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsReimageAllFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsReimageAllFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsReimageAllFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (VirtualMachineScaleSet, error)
}
func (future *VirtualMachineScaleSetsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsUpdateInstancesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsUpdateInstancesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (OperationStatusResponse, error)
}
func (future *VirtualMachineScaleSetsUpdateInstancesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineSize describes the properties of a VM size.
type VirtualMachineSize struct {
// Name - The name of the virtual machine size.
Name *string `json:"name,omitempty"`
// NumberOfCores - The number of cores supported by the virtual machine size.
NumberOfCores *int32 `json:"numberOfCores,omitempty"`
// OsDiskSizeInMB - The OS disk size, in MB, allowed by the virtual machine size.
OsDiskSizeInMB *int32 `json:"osDiskSizeInMB,omitempty"`
// ResourceDiskSizeInMB - The resource disk size, in MB, allowed by the virtual machine size.
ResourceDiskSizeInMB *int32 `json:"resourceDiskSizeInMB,omitempty"`
// MemoryInMB - The amount of memory, in MB, supported by the virtual machine size.
MemoryInMB *int32 `json:"memoryInMB,omitempty"`
// MaxDataDiskCount - The maximum number of data disks that can be attached to the virtual machine size.
MaxDataDiskCount *int32 `json:"maxDataDiskCount,omitempty"`
}
VirtualMachineSizeListResult the List Virtual Machine operation response.
type VirtualMachineSizeListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine sizes.
Value *[]VirtualMachineSize `json:"value,omitempty"`
}
VirtualMachineSizeTypes enumerates the values for virtual machine size types.
type VirtualMachineSizeTypes string
const (
// BasicA0 ...
BasicA0 VirtualMachineSizeTypes = "Basic_A0"
// BasicA1 ...
BasicA1 VirtualMachineSizeTypes = "Basic_A1"
// BasicA2 ...
BasicA2 VirtualMachineSizeTypes = "Basic_A2"
// BasicA3 ...
BasicA3 VirtualMachineSizeTypes = "Basic_A3"
// BasicA4 ...
BasicA4 VirtualMachineSizeTypes = "Basic_A4"
// StandardA0 ...
StandardA0 VirtualMachineSizeTypes = "Standard_A0"
// StandardA1 ...
StandardA1 VirtualMachineSizeTypes = "Standard_A1"
// StandardA10 ...
StandardA10 VirtualMachineSizeTypes = "Standard_A10"
// StandardA11 ...
StandardA11 VirtualMachineSizeTypes = "Standard_A11"
// StandardA1V2 ...
StandardA1V2 VirtualMachineSizeTypes = "Standard_A1_v2"
// StandardA2 ...
StandardA2 VirtualMachineSizeTypes = "Standard_A2"
// StandardA2mV2 ...
StandardA2mV2 VirtualMachineSizeTypes = "Standard_A2m_v2"
// StandardA2V2 ...
StandardA2V2 VirtualMachineSizeTypes = "Standard_A2_v2"
// StandardA3 ...
StandardA3 VirtualMachineSizeTypes = "Standard_A3"
// StandardA4 ...
StandardA4 VirtualMachineSizeTypes = "Standard_A4"
// StandardA4mV2 ...
StandardA4mV2 VirtualMachineSizeTypes = "Standard_A4m_v2"
// StandardA4V2 ...
StandardA4V2 VirtualMachineSizeTypes = "Standard_A4_v2"
// StandardA5 ...
StandardA5 VirtualMachineSizeTypes = "Standard_A5"
// StandardA6 ...
StandardA6 VirtualMachineSizeTypes = "Standard_A6"
// StandardA7 ...
StandardA7 VirtualMachineSizeTypes = "Standard_A7"
// StandardA8 ...
StandardA8 VirtualMachineSizeTypes = "Standard_A8"
// StandardA8mV2 ...
StandardA8mV2 VirtualMachineSizeTypes = "Standard_A8m_v2"
// StandardA8V2 ...
StandardA8V2 VirtualMachineSizeTypes = "Standard_A8_v2"
// StandardA9 ...
StandardA9 VirtualMachineSizeTypes = "Standard_A9"
// StandardD1 ...
StandardD1 VirtualMachineSizeTypes = "Standard_D1"
// StandardD11 ...
StandardD11 VirtualMachineSizeTypes = "Standard_D11"
// StandardD11V2 ...
StandardD11V2 VirtualMachineSizeTypes = "Standard_D11_v2"
// StandardD12 ...
StandardD12 VirtualMachineSizeTypes = "Standard_D12"
// StandardD12V2 ...
StandardD12V2 VirtualMachineSizeTypes = "Standard_D12_v2"
// StandardD13 ...
StandardD13 VirtualMachineSizeTypes = "Standard_D13"
// StandardD13V2 ...
StandardD13V2 VirtualMachineSizeTypes = "Standard_D13_v2"
// StandardD14 ...
StandardD14 VirtualMachineSizeTypes = "Standard_D14"
// StandardD14V2 ...
StandardD14V2 VirtualMachineSizeTypes = "Standard_D14_v2"
// StandardD15V2 ...
StandardD15V2 VirtualMachineSizeTypes = "Standard_D15_v2"
// StandardD1V2 ...
StandardD1V2 VirtualMachineSizeTypes = "Standard_D1_v2"
// StandardD2 ...
StandardD2 VirtualMachineSizeTypes = "Standard_D2"
// StandardD2V2 ...
StandardD2V2 VirtualMachineSizeTypes = "Standard_D2_v2"
// StandardD3 ...
StandardD3 VirtualMachineSizeTypes = "Standard_D3"
// StandardD3V2 ...
StandardD3V2 VirtualMachineSizeTypes = "Standard_D3_v2"
// StandardD4 ...
StandardD4 VirtualMachineSizeTypes = "Standard_D4"
// StandardD4V2 ...
StandardD4V2 VirtualMachineSizeTypes = "Standard_D4_v2"
// StandardD5V2 ...
StandardD5V2 VirtualMachineSizeTypes = "Standard_D5_v2"
// StandardDS1 ...
StandardDS1 VirtualMachineSizeTypes = "Standard_DS1"
// StandardDS11 ...
StandardDS11 VirtualMachineSizeTypes = "Standard_DS11"
// StandardDS11V2 ...
StandardDS11V2 VirtualMachineSizeTypes = "Standard_DS11_v2"
// StandardDS12 ...
StandardDS12 VirtualMachineSizeTypes = "Standard_DS12"
// StandardDS12V2 ...
StandardDS12V2 VirtualMachineSizeTypes = "Standard_DS12_v2"
// StandardDS13 ...
StandardDS13 VirtualMachineSizeTypes = "Standard_DS13"
// StandardDS13V2 ...
StandardDS13V2 VirtualMachineSizeTypes = "Standard_DS13_v2"
// StandardDS14 ...
StandardDS14 VirtualMachineSizeTypes = "Standard_DS14"
// StandardDS14V2 ...
StandardDS14V2 VirtualMachineSizeTypes = "Standard_DS14_v2"
// StandardDS15V2 ...
StandardDS15V2 VirtualMachineSizeTypes = "Standard_DS15_v2"
// StandardDS1V2 ...
StandardDS1V2 VirtualMachineSizeTypes = "Standard_DS1_v2"
// StandardDS2 ...
StandardDS2 VirtualMachineSizeTypes = "Standard_DS2"
// StandardDS2V2 ...
StandardDS2V2 VirtualMachineSizeTypes = "Standard_DS2_v2"
// StandardDS3 ...
StandardDS3 VirtualMachineSizeTypes = "Standard_DS3"
// StandardDS3V2 ...
StandardDS3V2 VirtualMachineSizeTypes = "Standard_DS3_v2"
// StandardDS4 ...
StandardDS4 VirtualMachineSizeTypes = "Standard_DS4"
// StandardDS4V2 ...
StandardDS4V2 VirtualMachineSizeTypes = "Standard_DS4_v2"
// StandardDS5V2 ...
StandardDS5V2 VirtualMachineSizeTypes = "Standard_DS5_v2"
// StandardF1 ...
StandardF1 VirtualMachineSizeTypes = "Standard_F1"
// StandardF16 ...
StandardF16 VirtualMachineSizeTypes = "Standard_F16"
// StandardF16s ...
StandardF16s VirtualMachineSizeTypes = "Standard_F16s"
// StandardF1s ...
StandardF1s VirtualMachineSizeTypes = "Standard_F1s"
// StandardF2 ...
StandardF2 VirtualMachineSizeTypes = "Standard_F2"
// StandardF2s ...
StandardF2s VirtualMachineSizeTypes = "Standard_F2s"
// StandardF4 ...
StandardF4 VirtualMachineSizeTypes = "Standard_F4"
// StandardF4s ...
StandardF4s VirtualMachineSizeTypes = "Standard_F4s"
// StandardF8 ...
StandardF8 VirtualMachineSizeTypes = "Standard_F8"
// StandardF8s ...
StandardF8s VirtualMachineSizeTypes = "Standard_F8s"
// StandardG1 ...
StandardG1 VirtualMachineSizeTypes = "Standard_G1"
// StandardG2 ...
StandardG2 VirtualMachineSizeTypes = "Standard_G2"
// StandardG3 ...
StandardG3 VirtualMachineSizeTypes = "Standard_G3"
// StandardG4 ...
StandardG4 VirtualMachineSizeTypes = "Standard_G4"
// StandardG5 ...
StandardG5 VirtualMachineSizeTypes = "Standard_G5"
// StandardGS1 ...
StandardGS1 VirtualMachineSizeTypes = "Standard_GS1"
// StandardGS2 ...
StandardGS2 VirtualMachineSizeTypes = "Standard_GS2"
// StandardGS3 ...
StandardGS3 VirtualMachineSizeTypes = "Standard_GS3"
// StandardGS4 ...
StandardGS4 VirtualMachineSizeTypes = "Standard_GS4"
// StandardGS5 ...
StandardGS5 VirtualMachineSizeTypes = "Standard_GS5"
// StandardH16 ...
StandardH16 VirtualMachineSizeTypes = "Standard_H16"
// StandardH16m ...
StandardH16m VirtualMachineSizeTypes = "Standard_H16m"
// StandardH16mr ...
StandardH16mr VirtualMachineSizeTypes = "Standard_H16mr"
// StandardH16r ...
StandardH16r VirtualMachineSizeTypes = "Standard_H16r"
// StandardH8 ...
StandardH8 VirtualMachineSizeTypes = "Standard_H8"
// StandardH8m ...
StandardH8m VirtualMachineSizeTypes = "Standard_H8m"
// StandardL16s ...
StandardL16s VirtualMachineSizeTypes = "Standard_L16s"
// StandardL32s ...
StandardL32s VirtualMachineSizeTypes = "Standard_L32s"
// StandardL4s ...
StandardL4s VirtualMachineSizeTypes = "Standard_L4s"
// StandardL8s ...
StandardL8s VirtualMachineSizeTypes = "Standard_L8s"
// StandardNC12 ...
StandardNC12 VirtualMachineSizeTypes = "Standard_NC12"
// StandardNC24 ...
StandardNC24 VirtualMachineSizeTypes = "Standard_NC24"
// StandardNC24r ...
StandardNC24r VirtualMachineSizeTypes = "Standard_NC24r"
// StandardNC6 ...
StandardNC6 VirtualMachineSizeTypes = "Standard_NC6"
// StandardNV12 ...
StandardNV12 VirtualMachineSizeTypes = "Standard_NV12"
// StandardNV24 ...
StandardNV24 VirtualMachineSizeTypes = "Standard_NV24"
// StandardNV6 ...
StandardNV6 VirtualMachineSizeTypes = "Standard_NV6"
)
func PossibleVirtualMachineSizeTypesValues() []VirtualMachineSizeTypes
PossibleVirtualMachineSizeTypesValues returns an array of possible values for the VirtualMachineSizeTypes const type.
VirtualMachineSizesClient is the compute Client
type VirtualMachineSizesClient struct {
BaseClient
}
func NewVirtualMachineSizesClient(subscriptionID string) VirtualMachineSizesClient
NewVirtualMachineSizesClient creates an instance of the VirtualMachineSizesClient client.
func NewVirtualMachineSizesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineSizesClient
NewVirtualMachineSizesClientWithBaseURI creates an instance of the VirtualMachineSizesClient 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 VirtualMachineSizesClient) List(ctx context.Context, location string) (result VirtualMachineSizeListResult, err error)
List lists all available virtual machine sizes for a subscription in a location. Parameters: location - the location upon which virtual-machine-sizes is queried.
func (client VirtualMachineSizesClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineSizesClient) ListResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineSizesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
VirtualMachineStatusCodeCount the status code and count of the virtual machine scale set instance view status summary.
type VirtualMachineStatusCodeCount struct {
// Code - READ-ONLY; The instance view status code.
Code *string `json:"code,omitempty"`
// Count - READ-ONLY; The number of instances having a particular status code.
Count *int32 `json:"count,omitempty"`
}
func (vmscc VirtualMachineStatusCodeCount) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineStatusCodeCount.
VirtualMachinesCaptureFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesCaptureFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachineCaptureResult, error)
}
func (future *VirtualMachinesCaptureFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesClient is the compute Client
type VirtualMachinesClient struct {
BaseClient
}
func NewVirtualMachinesClient(subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClient creates an instance of the VirtualMachinesClient client.
func NewVirtualMachinesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClientWithBaseURI creates an instance of the VirtualMachinesClient 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 VirtualMachinesClient) Capture(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineCaptureParameters) (result VirtualMachinesCaptureFuture, err error)
Capture captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Capture Virtual Machine operation.
func (client VirtualMachinesClient) CapturePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineCaptureParameters) (*http.Request, error)
CapturePreparer prepares the Capture request.
func (client VirtualMachinesClient) CaptureResponder(resp *http.Response) (result VirtualMachineCaptureResult, err error)
CaptureResponder handles the response to the Capture request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) CaptureSender(req *http.Request) (future VirtualMachinesCaptureFuture, err error)
CaptureSender sends the Capture request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ConvertToManagedDisks(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesConvertToManagedDisksFuture, err error)
ConvertToManagedDisks converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) ConvertToManagedDisksPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
ConvertToManagedDisksPreparer prepares the ConvertToManagedDisks request.
func (client VirtualMachinesClient) ConvertToManagedDisksResponder(resp *http.Response) (result OperationStatusResponse, err error)
ConvertToManagedDisksResponder handles the response to the ConvertToManagedDisks request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ConvertToManagedDisksSender(req *http.Request) (future VirtualMachinesConvertToManagedDisksFuture, err error)
ConvertToManagedDisksSender sends the ConvertToManagedDisks request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachine) (result VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Create Virtual Machine operation.
func (client VirtualMachinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachine) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachinesClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachine, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Deallocate(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesDeallocateFuture, err error)
Deallocate shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachinesClient) DeallocateResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) DeallocateSender(req *http.Request) (future VirtualMachinesDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Delete(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesDeleteFuture, err error)
Delete the operation to delete a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachinesClient) DeleteResponder(resp *http.Response) (result OperationStatusResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) DeleteSender(req *http.Request) (future VirtualMachinesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Generalize(ctx context.Context, resourceGroupName string, VMName string) (result OperationStatusResponse, err error)
Generalize sets the state of the virtual machine to generalized. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) GeneralizePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
GeneralizePreparer prepares the Generalize request.
func (client VirtualMachinesClient) GeneralizeResponder(resp *http.Response) (result OperationStatusResponse, err error)
GeneralizeResponder handles the response to the Generalize request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GeneralizeSender(req *http.Request) (*http.Response, error)
GeneralizeSender sends the Generalize request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Get(ctx context.Context, resourceGroupName string, VMName string, expand InstanceViewTypes) (result VirtualMachine, err error)
Get retrieves information about the model view or the instance view of a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. expand - the expand expression to apply on the operation.
func (client VirtualMachinesClient) GetExtensions(ctx context.Context, resourceGroupName string, VMName string, expand string) (result VirtualMachineExtensionsListResult, err error)
GetExtensions 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 VirtualMachinesClient) GetExtensionsPreparer(ctx context.Context, resourceGroupName string, VMName string, expand string) (*http.Request, error)
GetExtensionsPreparer prepares the GetExtensions request.
func (client VirtualMachinesClient) GetExtensionsResponder(resp *http.Response) (result VirtualMachineExtensionsListResult, err error)
GetExtensionsResponder handles the response to the GetExtensions request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GetExtensionsSender(req *http.Request) (*http.Response, error)
GetExtensionsSender sends the GetExtensions request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) GetPreparer(ctx context.Context, resourceGroupName string, VMName string, expand InstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachinesClient) GetResponder(resp *http.Response) (result VirtualMachine, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) 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 VirtualMachinesClient) InstanceView(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachineInstanceView, err error)
InstanceView retrieves information about the run-time state of a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) InstanceViewPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
InstanceViewPreparer prepares the InstanceView request.
func (client VirtualMachinesClient) InstanceViewResponder(resp *http.Response) (result VirtualMachineInstanceView, err error)
InstanceViewResponder handles the response to the InstanceView request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) InstanceViewSender(req *http.Request) (*http.Response, error)
InstanceViewSender sends the InstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) List(ctx context.Context, resourceGroupName string) (result VirtualMachineListResultPage, err error)
List lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines. Parameters: resourceGroupName - the name of the resource group.
func (client VirtualMachinesClient) ListAll(ctx context.Context) (result VirtualMachineListResultPage, err error)
ListAll lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
func (client VirtualMachinesClient) ListAllComplete(ctx context.Context) (result VirtualMachineListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client VirtualMachinesClient) ListAllResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListAvailableSizes(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachineSizeListResult, err error)
ListAvailableSizes lists all available virtual machine sizes to which the specified virtual machine can be resized. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
ListAvailableSizesPreparer prepares the ListAvailableSizes request.
func (client VirtualMachinesClient) 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 VirtualMachinesClient) 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 VirtualMachinesClient) ListByLocation(ctx context.Context, location string) (result VirtualMachineListResultPage, err error)
ListByLocation gets all the virtual machines under the specified subscription for the specified location. Parameters: location - the location for which virtual machines under the subscription are queried.
func (client VirtualMachinesClient) ListByLocationComplete(ctx context.Context, location string) (result VirtualMachineListResultIterator, err error)
ListByLocationComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListByLocationPreparer(ctx context.Context, location string) (*http.Request, error)
ListByLocationPreparer prepares the ListByLocation request.
func (client VirtualMachinesClient) ListByLocationResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListByLocationSender(req *http.Request) (*http.Response, error)
ListByLocationSender sends the ListByLocation request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListComplete(ctx context.Context, resourceGroupName string) (result VirtualMachineListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachinesClient) ListResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) PerformMaintenance(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesPerformMaintenanceFuture, err error)
PerformMaintenance the operation to perform maintenance on a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) PerformMaintenancePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
PerformMaintenancePreparer prepares the PerformMaintenance request.
func (client VirtualMachinesClient) PerformMaintenanceResponder(resp *http.Response) (result OperationStatusResponse, err error)
PerformMaintenanceResponder handles the response to the PerformMaintenance request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) PerformMaintenanceSender(req *http.Request) (future VirtualMachinesPerformMaintenanceFuture, err error)
PerformMaintenanceSender sends the PerformMaintenance request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) PowerOff(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesPowerOffFuture, err error)
PowerOff the operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachinesClient) PowerOffResponder(resp *http.Response) (result OperationStatusResponse, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) PowerOffSender(req *http.Request) (future VirtualMachinesPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Redeploy(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesRedeployFuture, err error)
Redeploy shuts down the virtual machine, moves it to a new node, and powers it back on. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) RedeployPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
RedeployPreparer prepares the Redeploy request.
func (client VirtualMachinesClient) RedeployResponder(resp *http.Response) (result OperationStatusResponse, err error)
RedeployResponder handles the response to the Redeploy request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RedeploySender(req *http.Request) (future VirtualMachinesRedeployFuture, err error)
RedeploySender sends the Redeploy request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Restart(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesRestartFuture, err error)
Restart the operation to restart a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachinesClient) RestartResponder(resp *http.Response) (result OperationStatusResponse, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RestartSender(req *http.Request) (future VirtualMachinesRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) RunCommand(ctx context.Context, resourceGroupName string, VMName string, parameters RunCommandInput) (result VirtualMachinesRunCommandFuture, err error)
RunCommand run command on the VM. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Run command operation.
func (client VirtualMachinesClient) RunCommandPreparer(ctx context.Context, resourceGroupName string, VMName string, parameters RunCommandInput) (*http.Request, error)
RunCommandPreparer prepares the RunCommand request.
func (client VirtualMachinesClient) RunCommandResponder(resp *http.Response) (result RunCommandResult, err error)
RunCommandResponder handles the response to the RunCommand request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RunCommandSender(req *http.Request) (future VirtualMachinesRunCommandFuture, err error)
RunCommandSender sends the RunCommand request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Start(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesStartFuture, err error)
Start the operation to start a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) StartPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachinesClient) StartResponder(resp *http.Response) (result OperationStatusResponse, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) StartSender(req *http.Request) (future VirtualMachinesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
VirtualMachinesConvertToManagedDisksFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesConvertToManagedDisksFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesConvertToManagedDisksFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachine, error)
}
func (future *VirtualMachinesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesPerformMaintenanceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesPerformMaintenanceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesPerformMaintenanceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRedeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRedeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesRedeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRunCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRunCommandFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (RunCommandResult, error)
}
func (future *VirtualMachinesRunCommandFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (OperationStatusResponse, error)
}
func (future *VirtualMachinesStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
WinRMConfiguration describes Windows Remote Management configuration of the VM
type WinRMConfiguration struct {
// Listeners - The list of Windows Remote Management listeners
Listeners *[]WinRMListener `json:"listeners,omitempty"`
}
WinRMListener describes Protocol and thumbprint of Windows Remote Management listener
type WinRMListener struct {
// Protocol - Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br> **https**. Possible values include: 'HTTP', 'HTTPS'
Protocol ProtocolTypes `json:"protocol,omitempty"`
// 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"`
}
WindowsConfiguration specifies Windows operating system settings on the virtual machine.
type WindowsConfiguration struct {
// ProvisionVMAgent - Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ProvisionVMAgent *bool `json:"provisionVMAgent,omitempty"`
// EnableAutomaticUpdates - Indicates whether virtual machine is enabled for automatic updates.
EnableAutomaticUpdates *bool `json:"enableAutomaticUpdates,omitempty"`
// TimeZone - Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"
TimeZone *string `json:"timeZone,omitempty"`
// AdditionalUnattendContent - Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
AdditionalUnattendContent *[]AdditionalUnattendContent `json:"additionalUnattendContent,omitempty"`
// WinRM - Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
WinRM *WinRMConfiguration `json:"winRM,omitempty"`
}
| Name | Synopsis |
|---|---|
| .. | |
| computeapi | Deprecated: Please note, this package has been deprecated. |