import "github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2019-12-01/compute"
Package compute implements the Azure ARM Compute service API version .
Compute Client
availabilitysets.go client.go containerservices.go dedicatedhostgroups.go dedicatedhosts.go diskencryptionsets.go disks.go enums.go galleries.go galleryapplications.go galleryapplicationversions.go galleryimages.go galleryimageversions.go images.go loganalytics.go models.go operations.go proximityplacementgroups.go resourceskus.go snapshots.go sshpublickeys.go usage.go version.go virtualmachineextensionimages.go virtualmachineextensions.go virtualmachineimages.go virtualmachineruncommands.go virtualmachines.go virtualmachinescalesetextensions.go virtualmachinescalesetrollingupgrades.go virtualmachinescalesets.go virtualmachinescalesetvmextensions.go virtualmachinescalesetvms.go virtualmachinesizes.go
const (
// DefaultBaseURI is the default URI used for the service Compute
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type APIEntityReference struct {
// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
ID *string `json:"id,omitempty"`
}APIEntityReference the API entity reference.
type APIError struct {
// Details - The Api error details
Details *[]APIErrorBase `json:"details,omitempty"`
// Innererror - The Api inner error
Innererror *InnerError `json:"innererror,omitempty"`
// Code - The error code.
Code *string `json:"code,omitempty"`
// Target - The target of the particular error.
Target *string `json:"target,omitempty"`
// Message - The error message.
Message *string `json:"message,omitempty"`
}APIError api error.
type APIErrorBase struct {
// Code - The error code.
Code *string `json:"code,omitempty"`
// Target - The target of the particular error.
Target *string `json:"target,omitempty"`
// Message - The error message.
Message *string `json:"message,omitempty"`
}APIErrorBase api error base.
AccessLevel enumerates the values for access level.
const (
// None ...
None AccessLevel = "None"
// Read ...
Read AccessLevel = "Read"
// Write ...
Write AccessLevel = "Write"
)func PossibleAccessLevelValues() []AccessLevel
PossibleAccessLevelValues returns an array of possible values for the AccessLevel const type.
type AccessURI struct {
autorest.Response `json:"-"`
// AccessSAS - READ-ONLY; A SAS uri for accessing a disk.
AccessSAS *string `json:"accessSAS,omitempty"`
}AccessURI a disk access SAS uri.
type AdditionalCapabilities struct {
// UltraSSDEnabled - The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.
UltraSSDEnabled *bool `json:"ultraSSDEnabled,omitempty"`
}AdditionalCapabilities enables or disables a capability on the virtual machine or virtual machine scale set.
type AdditionalUnattendContent struct {
// PassName - The pass name. Currently, the only allowable value is OobeSystem. Possible values include: 'OobeSystem'
PassName PassNames `json:"passName,omitempty"`
// ComponentName - The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: 'MicrosoftWindowsShellSetup'
ComponentName ComponentNames `json:"componentName,omitempty"`
// SettingName - Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands'
SettingName SettingNames `json:"settingName,omitempty"`
// Content - Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
Content *string `json:"content,omitempty"`
}AdditionalUnattendContent specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
AggregatedReplicationState enumerates the values for aggregated replication state.
const (
// Completed ...
Completed AggregatedReplicationState = "Completed"
// Failed ...
Failed AggregatedReplicationState = "Failed"
// InProgress ...
InProgress AggregatedReplicationState = "InProgress"
// Unknown ...
Unknown AggregatedReplicationState = "Unknown"
)func PossibleAggregatedReplicationStateValues() []AggregatedReplicationState
PossibleAggregatedReplicationStateValues returns an array of possible values for the AggregatedReplicationState const type.
type AutomaticOSUpgradePolicy struct {
// EnableAutomaticOSUpgrade - Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. <br><br> If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true.
EnableAutomaticOSUpgrade *bool `json:"enableAutomaticOSUpgrade,omitempty"`
// DisableAutomaticRollback - Whether OS image rollback feature should be disabled. Default value is false.
DisableAutomaticRollback *bool `json:"disableAutomaticRollback,omitempty"`
}AutomaticOSUpgradePolicy the configuration parameters used for performing automatic OS upgrade.
type AutomaticOSUpgradeProperties struct {
// AutomaticOSUpgradeSupported - Specifies whether automatic OS upgrade is supported on the image.
AutomaticOSUpgradeSupported *bool `json:"automaticOSUpgradeSupported,omitempty"`
}AutomaticOSUpgradeProperties describes automatic OS upgrade properties on the image.
type AutomaticRepairsPolicy struct {
// Enabled - Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
Enabled *bool `json:"enabled,omitempty"`
// GracePeriod - The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).
GracePeriod *string `json:"gracePeriod,omitempty"`
}AutomaticRepairsPolicy specifies the configuration parameters for automatic repairs on the virtual machine scale set.
type AvailabilitySet struct {
autorest.Response `json:"-"`
*AvailabilitySetProperties `json:"properties,omitempty"`
// Sku - Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
Sku *Sku `json:"sku,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}AvailabilitySet specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
func (as AvailabilitySet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySet.
func (as *AvailabilitySet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilitySet struct.
type AvailabilitySetListResult struct {
autorest.Response `json:"-"`
// Value - The list of availability sets
Value *[]AvailabilitySet `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
NextLink *string `json:"nextLink,omitempty"`
}AvailabilitySetListResult the List Availability Set operation response.
func (aslr AvailabilitySetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AvailabilitySetListResultIterator struct {
// contains filtered or unexported fields
}AvailabilitySetListResultIterator provides access to a complete listing of AvailabilitySet values.
func NewAvailabilitySetListResultIterator(page AvailabilitySetListResultPage) AvailabilitySetListResultIterator
Creates a new instance of the AvailabilitySetListResultIterator type.
func (iter *AvailabilitySetListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AvailabilitySetListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AvailabilitySetListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AvailabilitySetListResultIterator) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (iter AvailabilitySetListResultIterator) Value() AvailabilitySet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AvailabilitySetListResultPage struct {
// contains filtered or unexported fields
}AvailabilitySetListResultPage contains a page of AvailabilitySet values.
func NewAvailabilitySetListResultPage(cur AvailabilitySetListResult, getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage
Creates a new instance of the AvailabilitySetListResultPage type.
func (page *AvailabilitySetListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AvailabilitySetListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AvailabilitySetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AvailabilitySetListResultPage) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (page AvailabilitySetListResultPage) Values() []AvailabilitySet
Values returns the slice of values for the current page or nil if there are no values.
type AvailabilitySetProperties struct {
// PlatformUpdateDomainCount - Update Domain count.
PlatformUpdateDomainCount *int32 `json:"platformUpdateDomainCount,omitempty"`
// PlatformFaultDomainCount - Fault Domain count.
PlatformFaultDomainCount *int32 `json:"platformFaultDomainCount,omitempty"`
// VirtualMachines - A list of references to all virtual machines in the availability set.
VirtualMachines *[]SubResource `json:"virtualMachines,omitempty"`
// ProximityPlacementGroup - Specifies information about the proximity placement group that the availability set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
ProximityPlacementGroup *SubResource `json:"proximityPlacementGroup,omitempty"`
// Statuses - READ-ONLY; The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}AvailabilitySetProperties the instance view of a resource.
func (asp AvailabilitySetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetProperties.
AvailabilitySetSkuTypes enumerates the values for availability set sku types.
const (
// Aligned ...
Aligned AvailabilitySetSkuTypes = "Aligned"
// Classic ...
Classic AvailabilitySetSkuTypes = "Classic"
)func PossibleAvailabilitySetSkuTypesValues() []AvailabilitySetSkuTypes
PossibleAvailabilitySetSkuTypesValues returns an array of possible values for the AvailabilitySetSkuTypes const type.
type AvailabilitySetUpdate struct {
*AvailabilitySetProperties `json:"properties,omitempty"`
// Sku - Sku of the availability set
Sku *Sku `json:"sku,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}AvailabilitySetUpdate specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.
func (asu AvailabilitySetUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetUpdate.
func (asu *AvailabilitySetUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilitySetUpdate struct.
type AvailabilitySetsClient struct {
BaseClient
}AvailabilitySetsClient is the compute Client
func NewAvailabilitySetsClient(subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClient creates an instance of the AvailabilitySetsClient client.
func NewAvailabilitySetsClientWithBaseURI(baseURI string, subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClientWithBaseURI creates an instance of the AvailabilitySetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AvailabilitySetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (result AvailabilitySet, err error)
CreateOrUpdate create or update an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set. parameters - parameters supplied to the Create Availability Set operation.
func (client AvailabilitySetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AvailabilitySetsClient) CreateOrUpdateResponder(resp *http.Response) (result AvailabilitySet, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) Delete(ctx context.Context, resourceGroupName string, availabilitySetName string) (result autorest.Response, err error)
Delete delete an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.
func (client AvailabilitySetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client AvailabilitySetsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) Get(ctx context.Context, resourceGroupName string, availabilitySetName string) (result AvailabilitySet, err error)
Get retrieves information about an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.
func (client AvailabilitySetsClient) GetPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AvailabilitySetsClient) GetResponder(resp *http.Response) (result AvailabilitySet, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) List(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultPage, err error)
List lists all availability sets in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client AvailabilitySetsClient) ListAvailableSizes(ctx context.Context, resourceGroupName string, availabilitySetName string) (result VirtualMachineSizeListResult, err error)
ListAvailableSizes lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.
func (client AvailabilitySetsClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
ListAvailableSizesPreparer prepares the ListAvailableSizes request.
func (client AvailabilitySetsClient) ListAvailableSizesResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)
ListAvailableSizesResponder handles the response to the ListAvailableSizes request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) ListAvailableSizesSender(req *http.Request) (*http.Response, error)
ListAvailableSizesSender sends the ListAvailableSizes request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) ListBySubscription(ctx context.Context, expand string) (result AvailabilitySetListResultPage, err error)
ListBySubscription lists all availability sets in a subscription. Parameters: expand - the expand expression to apply to the operation. Allowed values are 'instanceView'.
func (client AvailabilitySetsClient) ListBySubscriptionComplete(ctx context.Context, expand string) (result AvailabilitySetListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListBySubscriptionPreparer(ctx context.Context, expand string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client AvailabilitySetsClient) ListBySubscriptionResponder(resp *http.Response) (result AvailabilitySetListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client AvailabilitySetsClient) ListResponder(resp *http.Response) (result AvailabilitySetListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) Update(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySetUpdate) (result AvailabilitySet, err error)
Update update an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set. parameters - parameters supplied to the Update Availability Set operation.
func (client AvailabilitySetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySetUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client AvailabilitySetsClient) UpdateResponder(resp *http.Response) (result AvailabilitySet, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
BaseClient is the base client for Compute.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type BillingProfile struct {
// MaxPrice - Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. <br><br> This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. <br><br> The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. <br><br> Possible values are: <br><br> - Any decimal value greater than zero. Example: 0.01538 <br><br> -1 – indicates default price to be up-to on-demand. <br><br> You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. <br><br>Minimum api-version: 2019-03-01.
MaxPrice *float64 `json:"maxPrice,omitempty"`
}BillingProfile specifies the billing related details of a Azure Spot VM or VMSS. <br><br>Minimum api-version: 2019-03-01.
type BootDiagnostics struct {
// Enabled - Whether boot diagnostics should be enabled on the Virtual Machine.
Enabled *bool `json:"enabled,omitempty"`
// StorageURI - Uri of the storage account to use for placing the console output and screenshot.
StorageURI *string `json:"storageUri,omitempty"`
}BootDiagnostics boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.
type BootDiagnosticsInstanceView struct {
// ConsoleScreenshotBlobURI - READ-ONLY; The console screenshot blob URI.
ConsoleScreenshotBlobURI *string `json:"consoleScreenshotBlobUri,omitempty"`
// SerialConsoleLogBlobURI - READ-ONLY; The Linux serial console log blob Uri.
SerialConsoleLogBlobURI *string `json:"serialConsoleLogBlobUri,omitempty"`
// Status - READ-ONLY; The boot diagnostics status information for the VM. <br><br> NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.
Status *InstanceViewStatus `json:"status,omitempty"`
}BootDiagnosticsInstanceView the instance view of a virtual machine boot diagnostics.
CachingTypes enumerates the values for caching types.
const (
// CachingTypesNone ...
CachingTypesNone CachingTypes = "None"
// CachingTypesReadOnly ...
CachingTypesReadOnly CachingTypes = "ReadOnly"
// CachingTypesReadWrite ...
CachingTypesReadWrite CachingTypes = "ReadWrite"
)func PossibleCachingTypesValues() []CachingTypes
PossibleCachingTypesValues returns an array of possible values for the CachingTypes const type.
CloudError an error response from the Compute service.
ComponentNames enumerates the values for component names.
const (
// MicrosoftWindowsShellSetup ...
MicrosoftWindowsShellSetup ComponentNames = "Microsoft-Windows-Shell-Setup"
)func PossibleComponentNamesValues() []ComponentNames
PossibleComponentNamesValues returns an array of possible values for the ComponentNames const type.
type ContainerService struct {
autorest.Response `json:"-"`
*ContainerServiceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}ContainerService container service.
func (cs ContainerService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerService.
func (cs *ContainerService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ContainerService struct.
type ContainerServiceAgentPoolProfile struct {
// Name - Unique name of the agent pool profile in the context of the subscription and resource group.
Name *string `json:"name,omitempty"`
// Count - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
Count *int32 `json:"count,omitempty"`
// VMSize - Size of agent VMs. Possible values include: 'StandardA0', 'StandardA1', 'StandardA2', 'StandardA3', 'StandardA4', 'StandardA5', 'StandardA6', 'StandardA7', 'StandardA8', 'StandardA9', 'StandardA10', 'StandardA11', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5'
VMSize ContainerServiceVMSizeTypes `json:"vmSize,omitempty"`
// DNSPrefix - DNS prefix to be used to create the FQDN for the agent pool.
DNSPrefix *string `json:"dnsPrefix,omitempty"`
// Fqdn - READ-ONLY; FQDN for the agent pool.
Fqdn *string `json:"fqdn,omitempty"`
}ContainerServiceAgentPoolProfile profile for the container service agent pool.
func (csapp ContainerServiceAgentPoolProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceAgentPoolProfile.
type ContainerServiceCustomProfile struct {
// Orchestrator - The name of the custom orchestrator to use.
Orchestrator *string `json:"orchestrator,omitempty"`
}ContainerServiceCustomProfile properties to configure a custom container service cluster.
type ContainerServiceDiagnosticsProfile struct {
// VMDiagnostics - Profile for the container service VM diagnostic agent.
VMDiagnostics *ContainerServiceVMDiagnostics `json:"vmDiagnostics,omitempty"`
}ContainerServiceDiagnosticsProfile ...
type ContainerServiceLinuxProfile struct {
// AdminUsername - The administrator username to use for Linux VMs.
AdminUsername *string `json:"adminUsername,omitempty"`
// SSH - The ssh key configuration for Linux VMs.
SSH *ContainerServiceSSHConfiguration `json:"ssh,omitempty"`
}ContainerServiceLinuxProfile profile for Linux VMs in the container service cluster.
type ContainerServiceListResult struct {
autorest.Response `json:"-"`
// Value - the list of container services.
Value *[]ContainerService `json:"value,omitempty"`
// NextLink - The URL to get the next set of container service results.
NextLink *string `json:"nextLink,omitempty"`
}ContainerServiceListResult the response from the List Container Services operation.
func (cslr ContainerServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ContainerServiceListResultIterator struct {
// contains filtered or unexported fields
}ContainerServiceListResultIterator provides access to a complete listing of ContainerService values.
func NewContainerServiceListResultIterator(page ContainerServiceListResultPage) ContainerServiceListResultIterator
Creates a new instance of the ContainerServiceListResultIterator type.
func (iter *ContainerServiceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ContainerServiceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ContainerServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ContainerServiceListResultIterator) Response() ContainerServiceListResult
Response returns the raw server response from the last page request.
func (iter ContainerServiceListResultIterator) Value() ContainerService
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ContainerServiceListResultPage struct {
// contains filtered or unexported fields
}ContainerServiceListResultPage contains a page of ContainerService values.
func NewContainerServiceListResultPage(cur ContainerServiceListResult, getNextPage func(context.Context, ContainerServiceListResult) (ContainerServiceListResult, error)) ContainerServiceListResultPage
Creates a new instance of the ContainerServiceListResultPage type.
func (page *ContainerServiceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ContainerServiceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ContainerServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ContainerServiceListResultPage) Response() ContainerServiceListResult
Response returns the raw server response from the last page request.
func (page ContainerServiceListResultPage) Values() []ContainerService
Values returns the slice of values for the current page or nil if there are no values.
type ContainerServiceMasterProfile struct {
// Count - Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.
Count *int32 `json:"count,omitempty"`
// DNSPrefix - DNS prefix to be used to create the FQDN for master.
DNSPrefix *string `json:"dnsPrefix,omitempty"`
// Fqdn - READ-ONLY; FQDN for the master.
Fqdn *string `json:"fqdn,omitempty"`
}ContainerServiceMasterProfile profile for the container service master.
func (csmp ContainerServiceMasterProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceMasterProfile.
type ContainerServiceOrchestratorProfile struct {
// OrchestratorType - The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', 'Kubernetes'
OrchestratorType ContainerServiceOrchestratorTypes `json:"orchestratorType,omitempty"`
}ContainerServiceOrchestratorProfile profile for the container service orchestrator.
ContainerServiceOrchestratorTypes enumerates the values for container service orchestrator types.
const (
// Custom ...
Custom ContainerServiceOrchestratorTypes = "Custom"
// DCOS ...
DCOS ContainerServiceOrchestratorTypes = "DCOS"
// Kubernetes ...
Kubernetes ContainerServiceOrchestratorTypes = "Kubernetes"
// Swarm ...
Swarm ContainerServiceOrchestratorTypes = "Swarm"
)func PossibleContainerServiceOrchestratorTypesValues() []ContainerServiceOrchestratorTypes
PossibleContainerServiceOrchestratorTypesValues returns an array of possible values for the ContainerServiceOrchestratorTypes const type.
type ContainerServiceProperties struct {
// ProvisioningState - READ-ONLY; the current deployment or provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// OrchestratorProfile - Properties of the orchestrator.
OrchestratorProfile *ContainerServiceOrchestratorProfile `json:"orchestratorProfile,omitempty"`
// CustomProfile - Properties for custom clusters.
CustomProfile *ContainerServiceCustomProfile `json:"customProfile,omitempty"`
// ServicePrincipalProfile - Properties for cluster service principals.
ServicePrincipalProfile *ContainerServiceServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"`
// MasterProfile - Properties of master agents.
MasterProfile *ContainerServiceMasterProfile `json:"masterProfile,omitempty"`
// AgentPoolProfiles - Properties of the agent pool.
AgentPoolProfiles *[]ContainerServiceAgentPoolProfile `json:"agentPoolProfiles,omitempty"`
// WindowsProfile - Properties of Windows VMs.
WindowsProfile *ContainerServiceWindowsProfile `json:"windowsProfile,omitempty"`
// LinuxProfile - Properties of Linux VMs.
LinuxProfile *ContainerServiceLinuxProfile `json:"linuxProfile,omitempty"`
// DiagnosticsProfile - Properties of the diagnostic agent.
DiagnosticsProfile *ContainerServiceDiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
}ContainerServiceProperties properties of the container service.
func (csp ContainerServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceProperties.
type ContainerServiceSSHConfiguration struct {
// PublicKeys - the list of SSH public keys used to authenticate with Linux-based VMs.
PublicKeys *[]ContainerServiceSSHPublicKey `json:"publicKeys,omitempty"`
}ContainerServiceSSHConfiguration SSH configuration for Linux-based VMs running on Azure.
type ContainerServiceSSHPublicKey struct {
// KeyData - Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.
KeyData *string `json:"keyData,omitempty"`
}ContainerServiceSSHPublicKey contains information about SSH certificate public key data.
type ContainerServiceServicePrincipalProfile struct {
// ClientID - The ID for the service principal.
ClientID *string `json:"clientId,omitempty"`
// Secret - The secret password associated with the service principal.
Secret *string `json:"secret,omitempty"`
}ContainerServiceServicePrincipalProfile information about a service principal identity for the cluster to use for manipulating Azure APIs.
type ContainerServiceVMDiagnostics struct {
// Enabled - Whether the VM diagnostic agent is provisioned on the VM.
Enabled *bool `json:"enabled,omitempty"`
// StorageURI - READ-ONLY; The URI of the storage account where diagnostics are stored.
StorageURI *string `json:"storageUri,omitempty"`
}ContainerServiceVMDiagnostics profile for diagnostics on the container service VMs.
func (csvd ContainerServiceVMDiagnostics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceVMDiagnostics.
ContainerServiceVMSizeTypes enumerates the values for container service vm size types.
const (
// StandardA0 ...
StandardA0 ContainerServiceVMSizeTypes = "Standard_A0"
// StandardA1 ...
StandardA1 ContainerServiceVMSizeTypes = "Standard_A1"
// StandardA10 ...
StandardA10 ContainerServiceVMSizeTypes = "Standard_A10"
// StandardA11 ...
StandardA11 ContainerServiceVMSizeTypes = "Standard_A11"
// StandardA2 ...
StandardA2 ContainerServiceVMSizeTypes = "Standard_A2"
// StandardA3 ...
StandardA3 ContainerServiceVMSizeTypes = "Standard_A3"
// StandardA4 ...
StandardA4 ContainerServiceVMSizeTypes = "Standard_A4"
// StandardA5 ...
StandardA5 ContainerServiceVMSizeTypes = "Standard_A5"
// StandardA6 ...
StandardA6 ContainerServiceVMSizeTypes = "Standard_A6"
// StandardA7 ...
StandardA7 ContainerServiceVMSizeTypes = "Standard_A7"
// StandardA8 ...
StandardA8 ContainerServiceVMSizeTypes = "Standard_A8"
// StandardA9 ...
StandardA9 ContainerServiceVMSizeTypes = "Standard_A9"
// StandardD1 ...
StandardD1 ContainerServiceVMSizeTypes = "Standard_D1"
// StandardD11 ...
StandardD11 ContainerServiceVMSizeTypes = "Standard_D11"
// StandardD11V2 ...
StandardD11V2 ContainerServiceVMSizeTypes = "Standard_D11_v2"
// StandardD12 ...
StandardD12 ContainerServiceVMSizeTypes = "Standard_D12"
// StandardD12V2 ...
StandardD12V2 ContainerServiceVMSizeTypes = "Standard_D12_v2"
// StandardD13 ...
StandardD13 ContainerServiceVMSizeTypes = "Standard_D13"
// StandardD13V2 ...
StandardD13V2 ContainerServiceVMSizeTypes = "Standard_D13_v2"
// StandardD14 ...
StandardD14 ContainerServiceVMSizeTypes = "Standard_D14"
// StandardD14V2 ...
StandardD14V2 ContainerServiceVMSizeTypes = "Standard_D14_v2"
// StandardD1V2 ...
StandardD1V2 ContainerServiceVMSizeTypes = "Standard_D1_v2"
// StandardD2 ...
StandardD2 ContainerServiceVMSizeTypes = "Standard_D2"
// StandardD2V2 ...
StandardD2V2 ContainerServiceVMSizeTypes = "Standard_D2_v2"
// StandardD3 ...
StandardD3 ContainerServiceVMSizeTypes = "Standard_D3"
// StandardD3V2 ...
StandardD3V2 ContainerServiceVMSizeTypes = "Standard_D3_v2"
// StandardD4 ...
StandardD4 ContainerServiceVMSizeTypes = "Standard_D4"
// StandardD4V2 ...
StandardD4V2 ContainerServiceVMSizeTypes = "Standard_D4_v2"
// StandardD5V2 ...
StandardD5V2 ContainerServiceVMSizeTypes = "Standard_D5_v2"
// StandardDS1 ...
StandardDS1 ContainerServiceVMSizeTypes = "Standard_DS1"
// StandardDS11 ...
StandardDS11 ContainerServiceVMSizeTypes = "Standard_DS11"
// StandardDS12 ...
StandardDS12 ContainerServiceVMSizeTypes = "Standard_DS12"
// StandardDS13 ...
StandardDS13 ContainerServiceVMSizeTypes = "Standard_DS13"
// StandardDS14 ...
StandardDS14 ContainerServiceVMSizeTypes = "Standard_DS14"
// StandardDS2 ...
StandardDS2 ContainerServiceVMSizeTypes = "Standard_DS2"
// StandardDS3 ...
StandardDS3 ContainerServiceVMSizeTypes = "Standard_DS3"
// StandardDS4 ...
StandardDS4 ContainerServiceVMSizeTypes = "Standard_DS4"
// StandardG1 ...
StandardG1 ContainerServiceVMSizeTypes = "Standard_G1"
// StandardG2 ...
StandardG2 ContainerServiceVMSizeTypes = "Standard_G2"
// StandardG3 ...
StandardG3 ContainerServiceVMSizeTypes = "Standard_G3"
// StandardG4 ...
StandardG4 ContainerServiceVMSizeTypes = "Standard_G4"
// StandardG5 ...
StandardG5 ContainerServiceVMSizeTypes = "Standard_G5"
// StandardGS1 ...
StandardGS1 ContainerServiceVMSizeTypes = "Standard_GS1"
// StandardGS2 ...
StandardGS2 ContainerServiceVMSizeTypes = "Standard_GS2"
// StandardGS3 ...
StandardGS3 ContainerServiceVMSizeTypes = "Standard_GS3"
// StandardGS4 ...
StandardGS4 ContainerServiceVMSizeTypes = "Standard_GS4"
// StandardGS5 ...
StandardGS5 ContainerServiceVMSizeTypes = "Standard_GS5"
)func PossibleContainerServiceVMSizeTypesValues() []ContainerServiceVMSizeTypes
PossibleContainerServiceVMSizeTypesValues returns an array of possible values for the ContainerServiceVMSizeTypes const type.
type ContainerServiceWindowsProfile struct {
// AdminUsername - The administrator username to use for Windows VMs.
AdminUsername *string `json:"adminUsername,omitempty"`
// AdminPassword - The administrator password to use for Windows VMs.
AdminPassword *string `json:"adminPassword,omitempty"`
}ContainerServiceWindowsProfile profile for Windows VMs in the container service cluster.
type ContainerServicesClient struct {
BaseClient
}ContainerServicesClient is the compute Client
func NewContainerServicesClient(subscriptionID string) ContainerServicesClient
NewContainerServicesClient creates an instance of the ContainerServicesClient client.
func NewContainerServicesClientWithBaseURI(baseURI string, subscriptionID string) ContainerServicesClient
NewContainerServicesClientWithBaseURI creates an instance of the ContainerServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ContainerServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (result ContainerServicesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a container service with the specified configuration of orchestrator, masters, and agents. Parameters: resourceGroupName - the name of the resource group. containerServiceName - the name of the container service in the specified subscription and resource group. parameters - parameters supplied to the Create or Update a Container Service operation.
func (client ContainerServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ContainerServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ContainerService, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ContainerServicesClient) CreateOrUpdateSender(req *http.Request) (future ContainerServicesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) Delete(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerServicesDeleteFuture, err error)
Delete deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually. Parameters: resourceGroupName - the name of the resource group. containerServiceName - the name of the container service in the specified subscription and resource group.
func (client ContainerServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ContainerServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ContainerServicesClient) DeleteSender(req *http.Request) (future ContainerServicesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) Get(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerService, err error)
Get gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. Parameters: resourceGroupName - the name of the resource group. containerServiceName - the name of the container service in the specified subscription and resource group.
func (client ContainerServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ContainerServicesClient) GetResponder(resp *http.Response) (result ContainerService, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) List(ctx context.Context) (result ContainerServiceListResultPage, err error)
List gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
func (client ContainerServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ContainerServiceListResultPage, err error)
ListByResourceGroup gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. Parameters: resourceGroupName - the name of the resource group.
func (client ContainerServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ContainerServiceListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ContainerServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ContainerServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ContainerServiceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ContainerServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) ListComplete(ctx context.Context) (result ContainerServiceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client ContainerServicesClient) ListResponder(resp *http.Response) (result ContainerServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ContainerServicesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ContainerServicesClient) (ContainerService, error)
}ContainerServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ContainerServicesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ContainerServicesClient) (autorest.Response, error)
}ContainerServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreationData struct {
// CreateOption - This enumerates the possible sources of a disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', 'Import', 'Copy', 'Restore', 'Upload'
CreateOption DiskCreateOption `json:"createOption,omitempty"`
// StorageAccountID - Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
StorageAccountID *string `json:"storageAccountId,omitempty"`
// ImageReference - Disk source information.
ImageReference *ImageDiskReference `json:"imageReference,omitempty"`
// GalleryImageReference - Required if creating from a Gallery Image. The id of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
GalleryImageReference *ImageDiskReference `json:"galleryImageReference,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"`
// SourceUniqueID - READ-ONLY; If this field is set, this is the unique id identifying the source of this resource.
SourceUniqueID *string `json:"sourceUniqueId,omitempty"`
// UploadSizeBytes - If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
UploadSizeBytes *int64 `json:"uploadSizeBytes,omitempty"`
}CreationData data used when creating a disk.
func (cd CreationData) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreationData.
type DataDisk struct {
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Vhd - The virtual hard disk.
Vhd *VirtualHardDisk `json:"vhd,omitempty"`
// Image - The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// CreateOption - Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiskSizeGB - Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
// ToBeDetached - Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset
ToBeDetached *bool `json:"toBeDetached,omitempty"`
// DiskIOPSReadWrite - READ-ONLY; Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - READ-ONLY; Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.
DiskMBpsReadWrite *int64 `json:"diskMBpsReadWrite,omitempty"`
}DataDisk describes a data disk.
MarshalJSON is the custom marshaler for DataDisk.
type DataDiskImage struct {
// Lun - READ-ONLY; Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
}DataDiskImage contains the data disk images information.
type DataDiskImageEncryption struct {
// Lun - This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine.
Lun *int32 `json:"lun,omitempty"`
// DiskEncryptionSetID - A relative URI containing the resource ID of the disk encryption set.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
}DataDiskImageEncryption contains encryption settings for a data disk image.
type DedicatedHost struct {
autorest.Response `json:"-"`
*DedicatedHostProperties `json:"properties,omitempty"`
// Sku - SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values.
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"`
}DedicatedHost specifies information about the Dedicated host.
func (dh DedicatedHost) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHost.
func (dh *DedicatedHost) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DedicatedHost struct.
type DedicatedHostAllocatableVM struct {
// VMSize - VM size in terms of which the unutilized capacity is represented.
VMSize *string `json:"vmSize,omitempty"`
// Count - Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.
Count *float64 `json:"count,omitempty"`
}DedicatedHostAllocatableVM represents the dedicated host unutilized capacity in terms of a specific VM size.
type DedicatedHostAvailableCapacity struct {
// AllocatableVMs - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
AllocatableVMs *[]DedicatedHostAllocatableVM `json:"allocatableVMs,omitempty"`
}DedicatedHostAvailableCapacity dedicated host unutilized capacity.
type DedicatedHostGroup struct {
autorest.Response `json:"-"`
*DedicatedHostGroupProperties `json:"properties,omitempty"`
// Zones - Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
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"`
}DedicatedHostGroup specifies information about the dedicated host group that the dedicated hosts should be assigned to. <br><br> Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.
func (dhg DedicatedHostGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostGroup.
func (dhg *DedicatedHostGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DedicatedHostGroup struct.
type DedicatedHostGroupListResult struct {
autorest.Response `json:"-"`
// Value - The list of dedicated host groups
Value *[]DedicatedHostGroup `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups.
NextLink *string `json:"nextLink,omitempty"`
}DedicatedHostGroupListResult the List Dedicated Host Group with resource group response.
func (dhglr DedicatedHostGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DedicatedHostGroupListResultIterator struct {
// contains filtered or unexported fields
}DedicatedHostGroupListResultIterator provides access to a complete listing of DedicatedHostGroup values.
func NewDedicatedHostGroupListResultIterator(page DedicatedHostGroupListResultPage) DedicatedHostGroupListResultIterator
Creates a new instance of the DedicatedHostGroupListResultIterator type.
func (iter *DedicatedHostGroupListResultIterator) 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 *DedicatedHostGroupListResultIterator) 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 DedicatedHostGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DedicatedHostGroupListResultIterator) Response() DedicatedHostGroupListResult
Response returns the raw server response from the last page request.
func (iter DedicatedHostGroupListResultIterator) Value() DedicatedHostGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DedicatedHostGroupListResultPage struct {
// contains filtered or unexported fields
}DedicatedHostGroupListResultPage contains a page of DedicatedHostGroup values.
func NewDedicatedHostGroupListResultPage(cur DedicatedHostGroupListResult, getNextPage func(context.Context, DedicatedHostGroupListResult) (DedicatedHostGroupListResult, error)) DedicatedHostGroupListResultPage
Creates a new instance of the DedicatedHostGroupListResultPage type.
func (page *DedicatedHostGroupListResultPage) 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 *DedicatedHostGroupListResultPage) 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 DedicatedHostGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DedicatedHostGroupListResultPage) Response() DedicatedHostGroupListResult
Response returns the raw server response from the last page request.
func (page DedicatedHostGroupListResultPage) Values() []DedicatedHostGroup
Values returns the slice of values for the current page or nil if there are no values.
type DedicatedHostGroupProperties struct {
// PlatformFaultDomainCount - Number of fault domains that the host group can span.
PlatformFaultDomainCount *int32 `json:"platformFaultDomainCount,omitempty"`
// Hosts - READ-ONLY; A list of references to all dedicated hosts in the dedicated host group.
Hosts *[]SubResourceReadOnly `json:"hosts,omitempty"`
}DedicatedHostGroupProperties dedicated Host Group Properties.
func (dhgp DedicatedHostGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostGroupProperties.
type DedicatedHostGroupUpdate struct {
*DedicatedHostGroupProperties `json:"properties,omitempty"`
// Zones - Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
Zones *[]string `json:"zones,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}DedicatedHostGroupUpdate specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.
func (dhgu DedicatedHostGroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostGroupUpdate.
func (dhgu *DedicatedHostGroupUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DedicatedHostGroupUpdate struct.
type DedicatedHostGroupsClient struct {
BaseClient
}DedicatedHostGroupsClient is the compute Client
func NewDedicatedHostGroupsClient(subscriptionID string) DedicatedHostGroupsClient
NewDedicatedHostGroupsClient creates an instance of the DedicatedHostGroupsClient client.
func NewDedicatedHostGroupsClientWithBaseURI(baseURI string, subscriptionID string) DedicatedHostGroupsClient
NewDedicatedHostGroupsClientWithBaseURI creates an instance of the DedicatedHostGroupsClient 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 DedicatedHostGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hostGroupName string, parameters DedicatedHostGroup) (result DedicatedHostGroup, err error)
CreateOrUpdate create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596) Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. parameters - parameters supplied to the Create Dedicated Host Group.
func (client DedicatedHostGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hostGroupName string, parameters DedicatedHostGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DedicatedHostGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result DedicatedHostGroup, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DedicatedHostGroupsClient) 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 DedicatedHostGroupsClient) Delete(ctx context.Context, resourceGroupName string, hostGroupName string) (result autorest.Response, err error)
Delete delete a dedicated host group. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group.
func (client DedicatedHostGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hostGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DedicatedHostGroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostGroupsClient) Get(ctx context.Context, resourceGroupName string, hostGroupName string) (result DedicatedHostGroup, err error)
Get retrieves information about a dedicated host group. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group.
func (client DedicatedHostGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, hostGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DedicatedHostGroupsClient) GetResponder(resp *http.Response) (result DedicatedHostGroup, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DedicatedHostGroupListResultPage, err error)
ListByResourceGroup lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups. Parameters: resourceGroupName - the name of the resource group.
func (client DedicatedHostGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DedicatedHostGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DedicatedHostGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DedicatedHostGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result DedicatedHostGroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DedicatedHostGroupsClient) 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 DedicatedHostGroupsClient) ListBySubscription(ctx context.Context) (result DedicatedHostGroupListResultPage, err error)
ListBySubscription lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
func (client DedicatedHostGroupsClient) ListBySubscriptionComplete(ctx context.Context) (result DedicatedHostGroupListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client DedicatedHostGroupsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client DedicatedHostGroupsClient) ListBySubscriptionResponder(resp *http.Response) (result DedicatedHostGroupListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client DedicatedHostGroupsClient) 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 DedicatedHostGroupsClient) Update(ctx context.Context, resourceGroupName string, hostGroupName string, parameters DedicatedHostGroupUpdate) (result DedicatedHostGroup, err error)
Update update an dedicated host group. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. parameters - parameters supplied to the Update Dedicated Host Group operation.
func (client DedicatedHostGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, hostGroupName string, parameters DedicatedHostGroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DedicatedHostGroupsClient) UpdateResponder(resp *http.Response) (result DedicatedHostGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DedicatedHostInstanceView struct {
// AssetID - READ-ONLY; Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
AssetID *string `json:"assetId,omitempty"`
// AvailableCapacity - Unutilized capacity of the dedicated host.
AvailableCapacity *DedicatedHostAvailableCapacity `json:"availableCapacity,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}DedicatedHostInstanceView the instance view of a dedicated host.
func (dhiv DedicatedHostInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostInstanceView.
DedicatedHostLicenseTypes enumerates the values for dedicated host license types.
const (
// DedicatedHostLicenseTypesNone ...
DedicatedHostLicenseTypesNone DedicatedHostLicenseTypes = "None"
// DedicatedHostLicenseTypesWindowsServerHybrid ...
DedicatedHostLicenseTypesWindowsServerHybrid DedicatedHostLicenseTypes = "Windows_Server_Hybrid"
// DedicatedHostLicenseTypesWindowsServerPerpetual ...
DedicatedHostLicenseTypesWindowsServerPerpetual DedicatedHostLicenseTypes = "Windows_Server_Perpetual"
)func PossibleDedicatedHostLicenseTypesValues() []DedicatedHostLicenseTypes
PossibleDedicatedHostLicenseTypesValues returns an array of possible values for the DedicatedHostLicenseTypes const type.
type DedicatedHostListResult struct {
autorest.Response `json:"-"`
// Value - The list of dedicated hosts
Value *[]DedicatedHost `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts.
NextLink *string `json:"nextLink,omitempty"`
}DedicatedHostListResult the list dedicated host operation response.
func (dhlr DedicatedHostListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DedicatedHostListResultIterator struct {
// contains filtered or unexported fields
}DedicatedHostListResultIterator provides access to a complete listing of DedicatedHost values.
func NewDedicatedHostListResultIterator(page DedicatedHostListResultPage) DedicatedHostListResultIterator
Creates a new instance of the DedicatedHostListResultIterator type.
func (iter *DedicatedHostListResultIterator) 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 *DedicatedHostListResultIterator) 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 DedicatedHostListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DedicatedHostListResultIterator) Response() DedicatedHostListResult
Response returns the raw server response from the last page request.
func (iter DedicatedHostListResultIterator) Value() DedicatedHost
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DedicatedHostListResultPage struct {
// contains filtered or unexported fields
}DedicatedHostListResultPage contains a page of DedicatedHost values.
func NewDedicatedHostListResultPage(cur DedicatedHostListResult, getNextPage func(context.Context, DedicatedHostListResult) (DedicatedHostListResult, error)) DedicatedHostListResultPage
Creates a new instance of the DedicatedHostListResultPage type.
func (page *DedicatedHostListResultPage) 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 *DedicatedHostListResultPage) 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 DedicatedHostListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DedicatedHostListResultPage) Response() DedicatedHostListResult
Response returns the raw server response from the last page request.
func (page DedicatedHostListResultPage) Values() []DedicatedHost
Values returns the slice of values for the current page or nil if there are no values.
type DedicatedHostProperties struct {
// PlatformFaultDomain - Fault domain of the dedicated host within a dedicated host group.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// AutoReplaceOnFailure - Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
AutoReplaceOnFailure *bool `json:"autoReplaceOnFailure,omitempty"`
// HostID - READ-ONLY; A unique id generated and assigned to the dedicated host by the platform. <br><br> Does not change throughout the lifetime of the host.
HostID *string `json:"hostId,omitempty"`
// VirtualMachines - READ-ONLY; A list of references to all virtual machines in the Dedicated Host.
VirtualMachines *[]SubResourceReadOnly `json:"virtualMachines,omitempty"`
// LicenseType - Specifies the software license type that will be applied to the VMs deployed on the dedicated host. <br><br> Possible values are: <br><br> **None** <br><br> **Windows_Server_Hybrid** <br><br> **Windows_Server_Perpetual** <br><br> Default: **None**. Possible values include: 'DedicatedHostLicenseTypesNone', 'DedicatedHostLicenseTypesWindowsServerHybrid', 'DedicatedHostLicenseTypesWindowsServerPerpetual'
LicenseType DedicatedHostLicenseTypes `json:"licenseType,omitempty"`
// ProvisioningTime - READ-ONLY; The date when the host was first provisioned.
ProvisioningTime *date.Time `json:"provisioningTime,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - READ-ONLY; The dedicated host instance view.
InstanceView *DedicatedHostInstanceView `json:"instanceView,omitempty"`
}DedicatedHostProperties properties of the dedicated host.
func (dhp DedicatedHostProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostProperties.
type DedicatedHostUpdate struct {
*DedicatedHostProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}DedicatedHostUpdate specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
func (dhu DedicatedHostUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostUpdate.
func (dhu *DedicatedHostUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DedicatedHostUpdate struct.
type DedicatedHostsClient struct {
BaseClient
}DedicatedHostsClient is the compute Client
func NewDedicatedHostsClient(subscriptionID string) DedicatedHostsClient
NewDedicatedHostsClient creates an instance of the DedicatedHostsClient client.
func NewDedicatedHostsClientWithBaseURI(baseURI string, subscriptionID string) DedicatedHostsClient
NewDedicatedHostsClientWithBaseURI creates an instance of the DedicatedHostsClient 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 DedicatedHostsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, parameters DedicatedHost) (result DedicatedHostsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a dedicated host . Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. hostName - the name of the dedicated host . parameters - parameters supplied to the Create Dedicated Host.
func (client DedicatedHostsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, parameters DedicatedHost) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DedicatedHostsClient) CreateOrUpdateResponder(resp *http.Response) (result DedicatedHost, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DedicatedHostsClient) CreateOrUpdateSender(req *http.Request) (future DedicatedHostsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostsClient) Delete(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string) (result DedicatedHostsDeleteFuture, err error)
Delete delete a dedicated host. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. hostName - the name of the dedicated host.
func (client DedicatedHostsClient) DeletePreparer(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DedicatedHostsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DedicatedHostsClient) DeleteSender(req *http.Request) (future DedicatedHostsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostsClient) Get(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, expand InstanceViewTypes) (result DedicatedHost, err error)
Get retrieves information about a dedicated host. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. hostName - the name of the dedicated host. expand - the expand expression to apply on the operation.
func (client DedicatedHostsClient) GetPreparer(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, expand InstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DedicatedHostsClient) GetResponder(resp *http.Response) (result DedicatedHost, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostsClient) ListByHostGroup(ctx context.Context, resourceGroupName string, hostGroupName string) (result DedicatedHostListResultPage, err error)
ListByHostGroup lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts. Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group.
func (client DedicatedHostsClient) ListByHostGroupComplete(ctx context.Context, resourceGroupName string, hostGroupName string) (result DedicatedHostListResultIterator, err error)
ListByHostGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DedicatedHostsClient) ListByHostGroupPreparer(ctx context.Context, resourceGroupName string, hostGroupName string) (*http.Request, error)
ListByHostGroupPreparer prepares the ListByHostGroup request.
func (client DedicatedHostsClient) ListByHostGroupResponder(resp *http.Response) (result DedicatedHostListResult, err error)
ListByHostGroupResponder handles the response to the ListByHostGroup request. The method always closes the http.Response Body.
func (client DedicatedHostsClient) ListByHostGroupSender(req *http.Request) (*http.Response, error)
ListByHostGroupSender sends the ListByHostGroup request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostsClient) Update(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, parameters DedicatedHostUpdate) (result DedicatedHostsUpdateFuture, err error)
Update update an dedicated host . Parameters: resourceGroupName - the name of the resource group. hostGroupName - the name of the dedicated host group. hostName - the name of the dedicated host . parameters - parameters supplied to the Update Dedicated Host operation.
func (client DedicatedHostsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string, parameters DedicatedHostUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DedicatedHostsClient) UpdateResponder(resp *http.Response) (result DedicatedHost, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DedicatedHostsClient) UpdateSender(req *http.Request) (future DedicatedHostsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DedicatedHostsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHostsClient) (DedicatedHost, error)
}DedicatedHostsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DedicatedHostsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHostsClient) (autorest.Response, error)
}DedicatedHostsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DedicatedHostsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHostsClient) (DedicatedHost, error)
}DedicatedHostsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiagnosticsProfile struct {
// BootDiagnostics - Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.
BootDiagnostics *BootDiagnostics `json:"bootDiagnostics,omitempty"`
}DiagnosticsProfile specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiffDiskOptions enumerates the values for diff disk options.
const (
// Local ...
Local DiffDiskOptions = "Local"
)func PossibleDiffDiskOptionsValues() []DiffDiskOptions
PossibleDiffDiskOptionsValues returns an array of possible values for the DiffDiskOptions const type.
DiffDiskPlacement enumerates the values for diff disk placement.
const (
// CacheDisk ...
CacheDisk DiffDiskPlacement = "CacheDisk"
// ResourceDisk ...
ResourceDisk DiffDiskPlacement = "ResourceDisk"
)func PossibleDiffDiskPlacementValues() []DiffDiskPlacement
PossibleDiffDiskPlacementValues returns an array of possible values for the DiffDiskPlacement const type.
type DiffDiskSettings struct {
// Option - Specifies the ephemeral disk settings for operating system disk. Possible values include: 'Local'
Option DiffDiskOptions `json:"option,omitempty"`
// Placement - Specifies the ephemeral disk placement for operating system disk.<br><br> Possible values are: <br><br> **CacheDisk** <br><br> **ResourceDisk** <br><br> Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.<br><br> Refer to VM size documentation for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'
Placement DiffDiskPlacement `json:"placement,omitempty"`
}DiffDiskSettings describes the parameters of ephemeral disk settings that can be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk.
type Disallowed struct {
// DiskTypes - A list of disk types.
DiskTypes *[]string `json:"diskTypes,omitempty"`
}Disallowed describes the disallowed disk types.
type Disk struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; A relative URI containing the ID of the VM that has the disk attached.
ManagedBy *string `json:"managedBy,omitempty"`
// ManagedByExtended - READ-ONLY; List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
ManagedByExtended *[]string `json:"managedByExtended,omitempty"`
Sku *DiskSku `json:"sku,omitempty"`
// Zones - The Logical zone list for Disk.
Zones *[]string `json:"zones,omitempty"`
*DiskProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}Disk disk resource.
MarshalJSON is the custom marshaler for Disk.
UnmarshalJSON is the custom unmarshaler for Disk struct.
DiskCreateOption enumerates the values for disk create option.
const (
// Attach Disk will be attached to a VM.
Attach DiskCreateOption = "Attach"
// Copy Create a new disk or snapshot by copying from a disk or snapshot specified by the given
// sourceResourceId.
Copy DiskCreateOption = "Copy"
// Empty Create an empty data disk of a size given by diskSizeGB.
Empty DiskCreateOption = "Empty"
// FromImage Create a new disk from a platform image specified by the given imageReference or
// galleryImageReference.
FromImage DiskCreateOption = "FromImage"
// Import Create a disk by importing from a blob specified by a sourceUri in a storage account specified by
// storageAccountId.
Import DiskCreateOption = "Import"
// Restore Create a new disk by copying from a backup recovery point.
Restore DiskCreateOption = "Restore"
// Upload Create a new disk by obtaining a write token and using it to directly upload the contents of the
// disk.
Upload DiskCreateOption = "Upload"
)func PossibleDiskCreateOptionValues() []DiskCreateOption
PossibleDiskCreateOptionValues returns an array of possible values for the DiskCreateOption const type.
DiskCreateOptionTypes enumerates the values for disk create option types.
const (
// DiskCreateOptionTypesAttach ...
DiskCreateOptionTypesAttach DiskCreateOptionTypes = "Attach"
// DiskCreateOptionTypesEmpty ...
DiskCreateOptionTypesEmpty DiskCreateOptionTypes = "Empty"
// DiskCreateOptionTypesFromImage ...
DiskCreateOptionTypesFromImage DiskCreateOptionTypes = "FromImage"
)func PossibleDiskCreateOptionTypesValues() []DiskCreateOptionTypes
PossibleDiskCreateOptionTypesValues returns an array of possible values for the DiskCreateOptionTypes const type.
type DiskEncryptionSet struct {
autorest.Response `json:"-"`
Identity *EncryptionSetIdentity `json:"identity,omitempty"`
*EncryptionSetProperties `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"`
}DiskEncryptionSet disk encryption set resource.
func (desVar DiskEncryptionSet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskEncryptionSet.
func (desVar *DiskEncryptionSet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskEncryptionSet struct.
DiskEncryptionSetIdentityType enumerates the values for disk encryption set identity type.
const (
// SystemAssigned ...
SystemAssigned DiskEncryptionSetIdentityType = "SystemAssigned"
)func PossibleDiskEncryptionSetIdentityTypeValues() []DiskEncryptionSetIdentityType
PossibleDiskEncryptionSetIdentityTypeValues returns an array of possible values for the DiskEncryptionSetIdentityType const type.
type DiskEncryptionSetList struct {
autorest.Response `json:"-"`
// Value - A list of disk encryption sets.
Value *[]DiskEncryptionSet `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets.
NextLink *string `json:"nextLink,omitempty"`
}DiskEncryptionSetList the List disk encryption set operation response.
func (desl DiskEncryptionSetList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DiskEncryptionSetListIterator struct {
// contains filtered or unexported fields
}DiskEncryptionSetListIterator provides access to a complete listing of DiskEncryptionSet values.
func NewDiskEncryptionSetListIterator(page DiskEncryptionSetListPage) DiskEncryptionSetListIterator
Creates a new instance of the DiskEncryptionSetListIterator type.
func (iter *DiskEncryptionSetListIterator) 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 *DiskEncryptionSetListIterator) 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 DiskEncryptionSetListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskEncryptionSetListIterator) Response() DiskEncryptionSetList
Response returns the raw server response from the last page request.
func (iter DiskEncryptionSetListIterator) Value() DiskEncryptionSet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DiskEncryptionSetListPage struct {
// contains filtered or unexported fields
}DiskEncryptionSetListPage contains a page of DiskEncryptionSet values.
func NewDiskEncryptionSetListPage(cur DiskEncryptionSetList, getNextPage func(context.Context, DiskEncryptionSetList) (DiskEncryptionSetList, error)) DiskEncryptionSetListPage
Creates a new instance of the DiskEncryptionSetListPage type.
func (page *DiskEncryptionSetListPage) 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 *DiskEncryptionSetListPage) 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 DiskEncryptionSetListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskEncryptionSetListPage) Response() DiskEncryptionSetList
Response returns the raw server response from the last page request.
func (page DiskEncryptionSetListPage) Values() []DiskEncryptionSet
Values returns the slice of values for the current page or nil if there are no values.
DiskEncryptionSetParameters describes the parameter of customer managed disk encryption set resource id that can be specified for disk. <br><br> NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.
type DiskEncryptionSetUpdate struct {
*DiskEncryptionSetUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}DiskEncryptionSetUpdate disk encryption set update resource.
func (desu DiskEncryptionSetUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskEncryptionSetUpdate.
func (desu *DiskEncryptionSetUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskEncryptionSetUpdate struct.
type DiskEncryptionSetUpdateProperties struct {
ActiveKey *KeyVaultAndKeyReference `json:"activeKey,omitempty"`
}DiskEncryptionSetUpdateProperties disk encryption set resource update properties.
type DiskEncryptionSetsClient struct {
BaseClient
}DiskEncryptionSetsClient is the compute Client
func NewDiskEncryptionSetsClient(subscriptionID string) DiskEncryptionSetsClient
NewDiskEncryptionSetsClient creates an instance of the DiskEncryptionSetsClient client.
func NewDiskEncryptionSetsClientWithBaseURI(baseURI string, subscriptionID string) DiskEncryptionSetsClient
NewDiskEncryptionSetsClientWithBaseURI creates an instance of the DiskEncryptionSetsClient 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 DiskEncryptionSetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskEncryptionSetName string, diskEncryptionSet DiskEncryptionSet) (result DiskEncryptionSetsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a disk encryption set Parameters: resourceGroupName - the name of the resource group. diskEncryptionSetName - the name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. diskEncryptionSet - disk encryption set object supplied in the body of the Put disk encryption set operation.
func (client DiskEncryptionSetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskEncryptionSetName string, diskEncryptionSet DiskEncryptionSet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DiskEncryptionSetsClient) CreateOrUpdateResponder(resp *http.Response) (result DiskEncryptionSet, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DiskEncryptionSetsClient) CreateOrUpdateSender(req *http.Request) (future DiskEncryptionSetsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DiskEncryptionSetsClient) Delete(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (result DiskEncryptionSetsDeleteFuture, err error)
Delete deletes a disk encryption set. Parameters: resourceGroupName - the name of the resource group. diskEncryptionSetName - the name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DiskEncryptionSetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DiskEncryptionSetsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DiskEncryptionSetsClient) DeleteSender(req *http.Request) (future DiskEncryptionSetsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DiskEncryptionSetsClient) Get(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (result DiskEncryptionSet, err error)
Get gets information about a disk encryption set. Parameters: resourceGroupName - the name of the resource group. diskEncryptionSetName - the name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DiskEncryptionSetsClient) GetPreparer(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DiskEncryptionSetsClient) GetResponder(resp *http.Response) (result DiskEncryptionSet, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DiskEncryptionSetsClient) List(ctx context.Context) (result DiskEncryptionSetListPage, err error)
List lists all the disk encryption sets under a subscription.
func (client DiskEncryptionSetsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskEncryptionSetListPage, err error)
ListByResourceGroup lists all the disk encryption sets under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client DiskEncryptionSetsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskEncryptionSetListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskEncryptionSetsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DiskEncryptionSetsClient) ListByResourceGroupResponder(resp *http.Response) (result DiskEncryptionSetList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DiskEncryptionSetsClient) 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 DiskEncryptionSetsClient) ListComplete(ctx context.Context) (result DiskEncryptionSetListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client DiskEncryptionSetsClient) ListResponder(resp *http.Response) (result DiskEncryptionSetList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DiskEncryptionSetsClient) Update(ctx context.Context, resourceGroupName string, diskEncryptionSetName string, diskEncryptionSet DiskEncryptionSetUpdate) (result DiskEncryptionSetsUpdateFuture, err error)
Update updates (patches) a disk encryption set. Parameters: resourceGroupName - the name of the resource group. diskEncryptionSetName - the name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. diskEncryptionSet - disk encryption set object supplied in the body of the Patch disk encryption set operation.
func (client DiskEncryptionSetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, diskEncryptionSetName string, diskEncryptionSet DiskEncryptionSetUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DiskEncryptionSetsClient) UpdateResponder(resp *http.Response) (result DiskEncryptionSet, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DiskEncryptionSetsClient) UpdateSender(req *http.Request) (future DiskEncryptionSetsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DiskEncryptionSetsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskEncryptionSetsClient) (DiskEncryptionSet, error)
}DiskEncryptionSetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskEncryptionSetsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskEncryptionSetsClient) (autorest.Response, error)
}DiskEncryptionSetsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskEncryptionSetsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskEncryptionSetsClient) (DiskEncryptionSet, error)
}DiskEncryptionSetsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskEncryptionSettings struct {
// DiskEncryptionKey - Specifies the location of the disk encryption key, which is a Key Vault Secret.
DiskEncryptionKey *KeyVaultSecretReference `json:"diskEncryptionKey,omitempty"`
// KeyEncryptionKey - Specifies the location of the key encryption key in Key Vault.
KeyEncryptionKey *KeyVaultKeyReference `json:"keyEncryptionKey,omitempty"`
// Enabled - Specifies whether disk encryption should be enabled on the virtual machine.
Enabled *bool `json:"enabled,omitempty"`
}DiskEncryptionSettings describes a Encryption Settings for a Disk
type DiskImageEncryption struct {
// DiskEncryptionSetID - A relative URI containing the resource ID of the disk encryption set.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
}DiskImageEncryption this is the disk image encryption base class.
type DiskInstanceView struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// EncryptionSettings - Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
EncryptionSettings *[]DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}DiskInstanceView the instance view of the disk.
type DiskList struct {
autorest.Response `json:"-"`
// Value - A list of disks.
Value *[]Disk `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks.
NextLink *string `json:"nextLink,omitempty"`
}DiskList the List Disks operation response.
IsEmpty returns true if the ListResult contains no values.
type DiskListIterator struct {
// contains filtered or unexported fields
}DiskListIterator provides access to a complete listing of Disk values.
func NewDiskListIterator(page DiskListPage) DiskListIterator
Creates a new instance of the DiskListIterator type.
func (iter *DiskListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DiskListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DiskListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskListIterator) Response() DiskList
Response returns the raw server response from the last page request.
func (iter DiskListIterator) Value() Disk
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DiskListPage struct {
// contains filtered or unexported fields
}DiskListPage contains a page of Disk values.
func NewDiskListPage(cur DiskList, getNextPage func(context.Context, DiskList) (DiskList, error)) DiskListPage
Creates a new instance of the DiskListPage type.
func (page *DiskListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DiskListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DiskListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskListPage) Response() DiskList
Response returns the raw server response from the last page request.
func (page DiskListPage) Values() []Disk
Values returns the slice of values for the current page or nil if there are no values.
type DiskProperties struct {
// TimeCreated - READ-ONLY; The time when the disk was created.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// OsType - The Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,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 disk 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"`
// DiskSizeBytes - READ-ONLY; The size of the disk in bytes. This field is read only.
DiskSizeBytes *int64 `json:"diskSizeBytes,omitempty"`
// UniqueID - READ-ONLY; Unique Guid identifying the resource.
UniqueID *string `json:"uniqueId,omitempty"`
// EncryptionSettingsCollection - Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
EncryptionSettingsCollection *EncryptionSettingsCollection `json:"encryptionSettingsCollection,omitempty"`
// ProvisioningState - READ-ONLY; The disk provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// DiskIOPSReadWrite - The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
DiskMBpsReadWrite *int64 `json:"diskMBpsReadWrite,omitempty"`
// DiskIOPSReadOnly - The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
DiskIOPSReadOnly *int64 `json:"diskIOPSReadOnly,omitempty"`
// DiskMBpsReadOnly - The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
DiskMBpsReadOnly *int64 `json:"diskMBpsReadOnly,omitempty"`
// DiskState - READ-ONLY; The state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', 'ActiveSAS', 'ReadyToUpload', 'ActiveUpload'
DiskState DiskState `json:"diskState,omitempty"`
// Encryption - Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Encryption *Encryption `json:"encryption,omitempty"`
// MaxShares - The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
*int32 `json:"maxShares,omitempty"`
// ShareInfo - READ-ONLY; Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.
*[]ShareInfoElement `json:"shareInfo,omitempty"`
}DiskProperties disk resource properties.
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
type DiskSku struct {
// Name - The sku name. Possible values include: 'StandardLRS', 'PremiumLRS', 'StandardSSDLRS', 'UltraSSDLRS'
Name DiskStorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}DiskSku the disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.
MarshalJSON is the custom marshaler for DiskSku.
DiskState enumerates the values for disk state.
const (
// ActiveSAS The disk currently has an Active SAS Uri associated with it.
ActiveSAS DiskState = "ActiveSAS"
// ActiveUpload A disk is created for upload and a write token has been issued for uploading to it.
ActiveUpload DiskState = "ActiveUpload"
// Attached The disk is currently mounted to a running VM.
Attached DiskState = "Attached"
// ReadyToUpload A disk is ready to be created by upload by requesting a write token.
ReadyToUpload DiskState = "ReadyToUpload"
// Reserved The disk is mounted to a stopped-deallocated VM
Reserved DiskState = "Reserved"
// Unattached The disk is not being used and can be attached to a VM.
Unattached DiskState = "Unattached"
)PossibleDiskStateValues returns an array of possible values for the DiskState const type.
DiskStorageAccountTypes enumerates the values for disk storage account types.
const (
// PremiumLRS Premium SSD locally redundant storage. Best for production and performance sensitive
// workloads.
PremiumLRS DiskStorageAccountTypes = "Premium_LRS"
// StandardLRS Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent
// access.
StandardLRS DiskStorageAccountTypes = "Standard_LRS"
// StandardSSDLRS Standard SSD locally redundant storage. Best for web servers, lightly used enterprise
// applications and dev/test.
StandardSSDLRS DiskStorageAccountTypes = "StandardSSD_LRS"
// UltraSSDLRS Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top
// tier databases (for example, SQL, Oracle), and other transaction-heavy workloads.
UltraSSDLRS DiskStorageAccountTypes = "UltraSSD_LRS"
)func PossibleDiskStorageAccountTypesValues() []DiskStorageAccountTypes
PossibleDiskStorageAccountTypesValues returns an array of possible values for the DiskStorageAccountTypes const type.
type DiskUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}DiskUpdate disk update resource.
func (du DiskUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskUpdate.
func (du *DiskUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskUpdate struct.
type DiskUpdateProperties struct {
// OsType - the Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// DiskSizeGB - If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk 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"`
// EncryptionSettingsCollection - Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
EncryptionSettingsCollection *EncryptionSettingsCollection `json:"encryptionSettingsCollection,omitempty"`
// DiskIOPSReadWrite - The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
DiskMBpsReadWrite *int64 `json:"diskMBpsReadWrite,omitempty"`
// DiskIOPSReadOnly - The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.
DiskIOPSReadOnly *int64 `json:"diskIOPSReadOnly,omitempty"`
// DiskMBpsReadOnly - The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
DiskMBpsReadOnly *int64 `json:"diskMBpsReadOnly,omitempty"`
// MaxShares - The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.
*int32 `json:"maxShares,omitempty"`
// Encryption - Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Encryption *Encryption `json:"encryption,omitempty"`
}DiskUpdateProperties disk resource update properties.
type DisksClient struct {
BaseClient
}DisksClient is the compute Client
func NewDisksClient(subscriptionID string) DisksClient
NewDisksClient creates an instance of the DisksClient client.
func NewDisksClientWithBaseURI(baseURI string, subscriptionID string) DisksClient
NewDisksClientWithBaseURI creates an instance of the DisksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DisksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (result DisksCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. disk - disk object supplied in the body of the Put disk operation.
func (client DisksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DisksClient) CreateOrUpdateSender(req *http.Request) (future DisksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Delete(ctx context.Context, resourceGroupName string, diskName string) (result DisksDeleteFuture, err error)
Delete deletes a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DisksClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DisksClient) DeleteSender(req *http.Request) (future DisksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Get(ctx context.Context, resourceGroupName string, diskName string) (result Disk, err error)
Get gets information about a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) GetPreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) GrantAccess(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (result DisksGrantAccessFuture, err error)
GrantAccess grants access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. grantAccessData - access data object supplied in the body of the get disk access operation.
func (client DisksClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client DisksClient) GrantAccessSender(req *http.Request) (future DisksGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) List(ctx context.Context) (result DiskListPage, err error)
List lists all the disks under a subscription.
func (client DisksClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskListPage, err error)
ListByResourceGroup lists all the disks under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client DisksClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DisksClient) ListByResourceGroupResponder(resp *http.Response) (result DiskList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) ListComplete(ctx context.Context) (result DiskListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) RevokeAccess(ctx context.Context, resourceGroupName string, diskName string) (result DisksRevokeAccessFuture, err error)
RevokeAccess revokes access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client DisksClient) RevokeAccessResponder(resp *http.Response) (result autorest.Response, err error)
RevokeAccessResponder handles the response to the RevokeAccess request. The method always closes the http.Response Body.
func (client DisksClient) RevokeAccessSender(req *http.Request) (future DisksRevokeAccessFuture, err error)
RevokeAccessSender sends the RevokeAccess request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Update(ctx context.Context, resourceGroupName string, diskName string, disk DiskUpdate) (result DisksUpdateFuture, err error)
Update updates (patches) a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. disk - disk object supplied in the body of the Patch disk operation.
func (client DisksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, diskName string, disk DiskUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DisksClient) UpdateSender(req *http.Request) (future DisksUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DisksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (AccessURI, error)
}DisksGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}DisksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Encryption struct {
// DiskEncryptionSetID - ResourceId of the disk encryption set to use for enabling encryption at rest.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
// Type - The type of key used to encrypt the data of the disk. Possible values include: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey'
Type EncryptionType `json:"type,omitempty"`
}Encryption encryption at rest settings for disk or snapshot
type EncryptionImages struct {
OsDiskImage *OSDiskImageEncryption `json:"osDiskImage,omitempty"`
// DataDiskImages - A list of encryption specifications for data disk images.
DataDiskImages *[]DataDiskImageEncryption `json:"dataDiskImages,omitempty"`
}EncryptionImages optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
type EncryptionSetIdentity struct {
// Type - The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. Possible values include: 'SystemAssigned'
Type DiskEncryptionSetIdentityType `json:"type,omitempty"`
// PrincipalID - READ-ONLY; The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
TenantID *string `json:"tenantId,omitempty"`
}EncryptionSetIdentity the managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
func (esi EncryptionSetIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionSetIdentity.
type EncryptionSetProperties struct {
// ActiveKey - The key vault key which is currently used by this disk encryption set.
ActiveKey *KeyVaultAndKeyReference `json:"activeKey,omitempty"`
// PreviousKeys - READ-ONLY; A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
PreviousKeys *[]KeyVaultAndKeyReference `json:"previousKeys,omitempty"`
// ProvisioningState - READ-ONLY; The disk encryption set provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
}EncryptionSetProperties ...
func (esp EncryptionSetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionSetProperties.
type EncryptionSettingsCollection 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"`
// EncryptionSettings - A collection of encryption settings, one for each disk volume.
EncryptionSettings *[]EncryptionSettingsElement `json:"encryptionSettings,omitempty"`
// EncryptionSettingsVersion - Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
EncryptionSettingsVersion *string `json:"encryptionSettingsVersion,omitempty"`
}EncryptionSettingsCollection encryption settings for disk or snapshot
type EncryptionSettingsElement struct {
// 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 is optional and when provided is used to unwrap the disk encryption key.
KeyEncryptionKey *KeyVaultAndKeyReference `json:"keyEncryptionKey,omitempty"`
}EncryptionSettingsElement encryption settings for one disk volume.
EncryptionType enumerates the values for encryption type.
const (
// EncryptionAtRestWithCustomerKey Disk is encrypted with Customer managed key at rest.
EncryptionAtRestWithCustomerKey EncryptionType = "EncryptionAtRestWithCustomerKey"
// EncryptionAtRestWithPlatformKey Disk is encrypted with XStore managed key at rest. It is the default
// encryption type.
EncryptionAtRestWithPlatformKey EncryptionType = "EncryptionAtRestWithPlatformKey"
)func PossibleEncryptionTypeValues() []EncryptionType
PossibleEncryptionTypeValues returns an array of possible values for the EncryptionType const type.
type GalleriesClient struct {
BaseClient
}GalleriesClient is the compute Client
func NewGalleriesClient(subscriptionID string) GalleriesClient
NewGalleriesClient creates an instance of the GalleriesClient client.
func NewGalleriesClientWithBaseURI(baseURI string, subscriptionID string) GalleriesClient
NewGalleriesClientWithBaseURI creates an instance of the GalleriesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleriesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, gallery Gallery) (result GalleriesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. gallery - parameters supplied to the create or update Shared Image Gallery operation.
func (client GalleriesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, gallery Gallery) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleriesClient) CreateOrUpdateResponder(resp *http.Response) (result Gallery, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleriesClient) CreateOrUpdateSender(req *http.Request) (future GalleriesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) Delete(ctx context.Context, resourceGroupName string, galleryName string) (result GalleriesDeleteFuture, err error)
Delete delete a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery to be deleted.
func (client GalleriesClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleriesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client GalleriesClient) DeleteSender(req *http.Request) (future GalleriesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) Get(ctx context.Context, resourceGroupName string, galleryName string) (result Gallery, err error)
Get retrieves information about a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery.
func (client GalleriesClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) List(ctx context.Context) (result GalleryListPage, err error)
List list galleries under a subscription.
func (client GalleriesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result GalleryListPage, err error)
ListByResourceGroup list galleries under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client GalleriesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result GalleryListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleriesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client GalleriesClient) ListByResourceGroupResponder(resp *http.Response) (result GalleryList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) ListComplete(ctx context.Context) (result GalleryListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client GalleriesClient) ListResponder(resp *http.Response) (result GalleryList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) Update(ctx context.Context, resourceGroupName string, galleryName string, gallery GalleryUpdate) (result GalleriesUpdateFuture, err error)
Update update a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. gallery - parameters supplied to the update Shared Image Gallery operation.
func (client GalleriesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, gallery GalleryUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GalleriesClient) UpdateSender(req *http.Request) (future GalleriesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type GalleriesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleriesClient) (Gallery, error)
}GalleriesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleriesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleriesClient) (autorest.Response, error)
}GalleriesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleriesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleriesClient) (Gallery, error)
}GalleriesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Gallery struct {
autorest.Response `json:"-"`
*GalleryProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}Gallery specifies information about the Shared Image Gallery that you want to create or update.
MarshalJSON is the custom marshaler for Gallery.
UnmarshalJSON is the custom unmarshaler for Gallery struct.
type GalleryApplication struct {
autorest.Response `json:"-"`
*GalleryApplicationProperties `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"`
}GalleryApplication specifies information about the gallery Application Definition that you want to create or update.
func (ga GalleryApplication) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplication.
func (ga *GalleryApplication) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryApplication struct.
type GalleryApplicationList struct {
autorest.Response `json:"-"`
// Value - A list of Gallery Applications.
Value *[]GalleryApplication `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions.
NextLink *string `json:"nextLink,omitempty"`
}GalleryApplicationList the List Gallery Applications operation response.
func (gal GalleryApplicationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryApplicationListIterator struct {
// contains filtered or unexported fields
}GalleryApplicationListIterator provides access to a complete listing of GalleryApplication values.
func NewGalleryApplicationListIterator(page GalleryApplicationListPage) GalleryApplicationListIterator
Creates a new instance of the GalleryApplicationListIterator type.
func (iter *GalleryApplicationListIterator) 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 *GalleryApplicationListIterator) 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 GalleryApplicationListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryApplicationListIterator) Response() GalleryApplicationList
Response returns the raw server response from the last page request.
func (iter GalleryApplicationListIterator) Value() GalleryApplication
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryApplicationListPage struct {
// contains filtered or unexported fields
}GalleryApplicationListPage contains a page of GalleryApplication values.
func NewGalleryApplicationListPage(cur GalleryApplicationList, getNextPage func(context.Context, GalleryApplicationList) (GalleryApplicationList, error)) GalleryApplicationListPage
Creates a new instance of the GalleryApplicationListPage type.
func (page *GalleryApplicationListPage) 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 *GalleryApplicationListPage) 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 GalleryApplicationListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryApplicationListPage) Response() GalleryApplicationList
Response returns the raw server response from the last page request.
func (page GalleryApplicationListPage) Values() []GalleryApplication
Values returns the slice of values for the current page or nil if there are no values.
type GalleryApplicationProperties struct {
// Description - The description of this gallery Application Definition resource. This property is updatable.
Description *string `json:"description,omitempty"`
// Eula - The Eula agreement for the gallery Application Definition.
Eula *string `json:"eula,omitempty"`
// PrivacyStatementURI - The privacy statement uri.
PrivacyStatementURI *string `json:"privacyStatementUri,omitempty"`
// ReleaseNoteURI - The release note uri.
ReleaseNoteURI *string `json:"releaseNoteUri,omitempty"`
// EndOfLifeDate - The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
// SupportedOSType - This property allows you to specify the supported type of the OS that application is built for. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'Windows', 'Linux'
SupportedOSType OperatingSystemTypes `json:"supportedOSType,omitempty"`
}GalleryApplicationProperties describes the properties of a gallery Application Definition.
type GalleryApplicationUpdate struct {
*GalleryApplicationProperties `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"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}GalleryApplicationUpdate specifies information about the gallery Application Definition that you want to update.
func (gau GalleryApplicationUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationUpdate.
func (gau *GalleryApplicationUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryApplicationUpdate struct.
type GalleryApplicationVersion struct {
autorest.Response `json:"-"`
*GalleryApplicationVersionProperties `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"`
}GalleryApplicationVersion specifies information about the gallery Application Version that you want to create or update.
func (gav GalleryApplicationVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersion.
func (gav *GalleryApplicationVersion) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryApplicationVersion struct.
type GalleryApplicationVersionList struct {
autorest.Response `json:"-"`
// Value - A list of gallery Application Versions.
Value *[]GalleryApplicationVersion `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions.
NextLink *string `json:"nextLink,omitempty"`
}GalleryApplicationVersionList the List Gallery Application version operation response.
func (gavl GalleryApplicationVersionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryApplicationVersionListIterator struct {
// contains filtered or unexported fields
}GalleryApplicationVersionListIterator provides access to a complete listing of GalleryApplicationVersion values.
func NewGalleryApplicationVersionListIterator(page GalleryApplicationVersionListPage) GalleryApplicationVersionListIterator
Creates a new instance of the GalleryApplicationVersionListIterator type.
func (iter *GalleryApplicationVersionListIterator) 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 *GalleryApplicationVersionListIterator) 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 GalleryApplicationVersionListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryApplicationVersionListIterator) Response() GalleryApplicationVersionList
Response returns the raw server response from the last page request.
func (iter GalleryApplicationVersionListIterator) Value() GalleryApplicationVersion
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryApplicationVersionListPage struct {
// contains filtered or unexported fields
}GalleryApplicationVersionListPage contains a page of GalleryApplicationVersion values.
func NewGalleryApplicationVersionListPage(cur GalleryApplicationVersionList, getNextPage func(context.Context, GalleryApplicationVersionList) (GalleryApplicationVersionList, error)) GalleryApplicationVersionListPage
Creates a new instance of the GalleryApplicationVersionListPage type.
func (page *GalleryApplicationVersionListPage) 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 *GalleryApplicationVersionListPage) 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 GalleryApplicationVersionListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryApplicationVersionListPage) Response() GalleryApplicationVersionList
Response returns the raw server response from the last page request.
func (page GalleryApplicationVersionListPage) Values() []GalleryApplicationVersion
Values returns the slice of values for the current page or nil if there are no values.
type GalleryApplicationVersionProperties struct {
PublishingProfile *GalleryApplicationVersionPublishingProfile `json:"publishingProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningState1Creating', 'ProvisioningState1Updating', 'ProvisioningState1Failed', 'ProvisioningState1Succeeded', 'ProvisioningState1Deleting', 'ProvisioningState1Migrating'
ProvisioningState ProvisioningState1 `json:"provisioningState,omitempty"`
// ReplicationStatus - READ-ONLY
ReplicationStatus *ReplicationStatus `json:"replicationStatus,omitempty"`
}GalleryApplicationVersionProperties describes the properties of a gallery Image Version.
func (gavp GalleryApplicationVersionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersionProperties.
type GalleryApplicationVersionPublishingProfile struct {
Source *UserArtifactSource `json:"source,omitempty"`
// ContentType - Optional. May be used to help process this file. The type of file contained in the source, e.g. zip, json, etc.
ContentType *string `json:"contentType,omitempty"`
// EnableHealthCheck - Optional. Whether or not this application reports health.
EnableHealthCheck *bool `json:"enableHealthCheck,omitempty"`
// TargetRegions - The target regions where the Image Version is going to be replicated to. This property is updatable.
TargetRegions *[]TargetRegion `json:"targetRegions,omitempty"`
// ReplicaCount - The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
ReplicaCount *int32 `json:"replicaCount,omitempty"`
// ExcludeFromLatest - If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
ExcludeFromLatest *bool `json:"excludeFromLatest,omitempty"`
// PublishedDate - READ-ONLY; The timestamp for when the gallery Image Version is published.
PublishedDate *date.Time `json:"publishedDate,omitempty"`
// EndOfLifeDate - The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
// StorageAccountType - Specifies the storage account type to be used to store the image. This property is not updatable. Possible values include: 'StorageAccountTypeStandardLRS', 'StorageAccountTypeStandardZRS', 'StorageAccountTypePremiumLRS'
StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}GalleryApplicationVersionPublishingProfile the publishing profile of a gallery Image Version.
func (gavpp GalleryApplicationVersionPublishingProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersionPublishingProfile.
type GalleryApplicationVersionUpdate struct {
*GalleryApplicationVersionProperties `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"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}GalleryApplicationVersionUpdate specifies information about the gallery Application Version that you want to update.
func (gavu GalleryApplicationVersionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersionUpdate.
func (gavu *GalleryApplicationVersionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryApplicationVersionUpdate struct.