const (
// DefaultBaseURI is the default URI used for the service Compute
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
APIEntityReference the API entity reference.
type APIEntityReference struct {
// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
ID *string `json:"id,omitempty"`
}
APIError api error.
type APIError struct {
// Details - The Api error details
Details *[]APIErrorBase `json:"details,omitempty"`
// Innererror - The Api inner error
Innererror *InnerError `json:"innererror,omitempty"`
// Code - The error code.
Code *string `json:"code,omitempty"`
// Target - The target of the particular error.
Target *string `json:"target,omitempty"`
// Message - The error message.
Message *string `json:"message,omitempty"`
}
APIErrorBase api error base.
type APIErrorBase struct {
// Code - The error code.
Code *string `json:"code,omitempty"`
// Target - The target of the particular error.
Target *string `json:"target,omitempty"`
// Message - The error message.
Message *string `json:"message,omitempty"`
}
AccessLevel enumerates the values for access level.
type AccessLevel string
const (
// AccessLevelNone ...
AccessLevelNone AccessLevel = "None"
// AccessLevelRead ...
AccessLevelRead AccessLevel = "Read"
// AccessLevelWrite ...
AccessLevelWrite AccessLevel = "Write"
)
func PossibleAccessLevelValues() []AccessLevel
PossibleAccessLevelValues returns an array of possible values for the AccessLevel const type.
AccessURI a disk access SAS uri.
type AccessURI struct {
autorest.Response `json:"-"`
// AccessSAS - READ-ONLY; A SAS uri for accessing a disk.
AccessSAS *string `json:"accessSAS,omitempty"`
// SecurityDataAccessSAS - READ-ONLY; A SAS uri for accessing a VM guest state.
SecurityDataAccessSAS *string `json:"securityDataAccessSAS,omitempty"`
}
func (au AccessURI) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccessURI.
AdditionalCapabilities enables or disables a capability on the virtual machine or virtual machine scale set.
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"`
// HibernationEnabled - The flag that enables or disables hibernation capability on the VM.
HibernationEnabled *bool `json:"hibernationEnabled,omitempty"`
}
AdditionalUnattendContent specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
type AdditionalUnattendContent struct {
// PassName - The pass name. Currently, the only allowable value is OobeSystem. Possible values include: 'PassNamesOobeSystem'
PassName PassNames `json:"passName,omitempty"`
// ComponentName - The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: 'ComponentNamesMicrosoftWindowsShellSetup'
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: 'SettingNamesAutoLogon', 'SettingNamesFirstLogonCommands'
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"`
}
AggregatedReplicationState enumerates the values for aggregated replication state.
type AggregatedReplicationState string
const (
// AggregatedReplicationStateCompleted ...
AggregatedReplicationStateCompleted AggregatedReplicationState = "Completed"
// AggregatedReplicationStateFailed ...
AggregatedReplicationStateFailed AggregatedReplicationState = "Failed"
// AggregatedReplicationStateInProgress ...
AggregatedReplicationStateInProgress AggregatedReplicationState = "InProgress"
// AggregatedReplicationStateUnknown ...
AggregatedReplicationStateUnknown AggregatedReplicationState = "Unknown"
)
func PossibleAggregatedReplicationStateValues() []AggregatedReplicationState
PossibleAggregatedReplicationStateValues returns an array of possible values for the AggregatedReplicationState const type.
ApplicationProfile contains the list of gallery applications that should be made available to the VM/VMSS
type ApplicationProfile struct {
// GalleryApplications - Specifies the gallery applications that should be made available to the VM/VMSS
GalleryApplications *[]VMGalleryApplication `json:"galleryApplications,omitempty"`
}
Architecture enumerates the values for architecture.
type Architecture string
const (
// ArchitectureArm64 ...
ArchitectureArm64 Architecture = "Arm64"
// ArchitectureX64 ...
ArchitectureX64 Architecture = "x64"
)
func PossibleArchitectureValues() []Architecture
PossibleArchitectureValues returns an array of possible values for the Architecture const type.
ArchitectureTypes enumerates the values for architecture types.
type ArchitectureTypes string
const (
// ArchitectureTypesArm64 ...
ArchitectureTypesArm64 ArchitectureTypes = "Arm64"
// ArchitectureTypesX64 ...
ArchitectureTypesX64 ArchitectureTypes = "x64"
)
func PossibleArchitectureTypesValues() []ArchitectureTypes
PossibleArchitectureTypesValues returns an array of possible values for the ArchitectureTypes const type.
AutomaticOSUpgradePolicy the configuration parameters used for performing automatic OS upgrade.
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"`
}
AutomaticOSUpgradeProperties describes automatic OS upgrade properties on the image.
type AutomaticOSUpgradeProperties struct {
// AutomaticOSUpgradeSupported - Specifies whether automatic OS upgrade is supported on the image.
AutomaticOSUpgradeSupported *bool `json:"automaticOSUpgradeSupported,omitempty"`
}
AutomaticRepairsPolicy specifies the configuration parameters for automatic repairs on the virtual machine scale set.
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 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).
GracePeriod *string `json:"gracePeriod,omitempty"`
// RepairAction - Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. Possible values include: 'RepairActionReplace', 'RepairActionRestart', 'RepairActionReimage'
RepairAction RepairAction `json:"repairAction,omitempty"`
}
AvailabilitySet specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
type AvailabilitySet struct {
autorest.Response `json:"-"`
*AvailabilitySetProperties `json:"properties,omitempty"`
// Sku - Sku of the availability set, 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"`
}
func (as AvailabilitySet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySet.
func (as *AvailabilitySet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilitySet struct.
AvailabilitySetListResult the List Availability Set operation response.
type AvailabilitySetListResult struct {
autorest.Response `json:"-"`
// Value - The list of availability sets
Value *[]AvailabilitySet `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
NextLink *string `json:"nextLink,omitempty"`
}
func (aslr AvailabilitySetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AvailabilitySetListResultIterator provides access to a complete listing of AvailabilitySet values.
type AvailabilitySetListResultIterator struct {
// contains filtered or unexported fields
}
func NewAvailabilitySetListResultIterator(page AvailabilitySetListResultPage) AvailabilitySetListResultIterator
Creates a new instance of the AvailabilitySetListResultIterator type.
func (iter *AvailabilitySetListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AvailabilitySetListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AvailabilitySetListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AvailabilitySetListResultIterator) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (iter AvailabilitySetListResultIterator) Value() AvailabilitySet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AvailabilitySetListResultPage contains a page of AvailabilitySet values.
type AvailabilitySetListResultPage struct {
// contains filtered or unexported fields
}
func NewAvailabilitySetListResultPage(cur AvailabilitySetListResult, getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage
Creates a new instance of the AvailabilitySetListResultPage type.
func (page *AvailabilitySetListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AvailabilitySetListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AvailabilitySetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AvailabilitySetListResultPage) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (page AvailabilitySetListResultPage) Values() []AvailabilitySet
Values returns the slice of values for the current page or nil if there are no values.
AvailabilitySetProperties the instance view of a resource.
type AvailabilitySetProperties struct {
// PlatformUpdateDomainCount - Update Domain count.
PlatformUpdateDomainCount *int32 `json:"platformUpdateDomainCount,omitempty"`
// PlatformFaultDomainCount - Fault Domain count.
PlatformFaultDomainCount *int32 `json:"platformFaultDomainCount,omitempty"`
// VirtualMachines - A list of references to all virtual machines in the availability set.
VirtualMachines *[]SubResource `json:"virtualMachines,omitempty"`
// 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"`
}
func (asp AvailabilitySetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetProperties.
AvailabilitySetSkuTypes enumerates the values for availability set sku types.
type AvailabilitySetSkuTypes string
const (
// AvailabilitySetSkuTypesAligned ...
AvailabilitySetSkuTypesAligned AvailabilitySetSkuTypes = "Aligned"
// AvailabilitySetSkuTypesClassic ...
AvailabilitySetSkuTypesClassic AvailabilitySetSkuTypes = "Classic"
)
func PossibleAvailabilitySetSkuTypesValues() []AvailabilitySetSkuTypes
PossibleAvailabilitySetSkuTypesValues returns an array of possible values for the AvailabilitySetSkuTypes const type.
AvailabilitySetUpdate specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.
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"`
}
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.
AvailabilitySetsClient is the compute Client
type AvailabilitySetsClient struct {
BaseClient
}
func NewAvailabilitySetsClient(subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClient creates an instance of the AvailabilitySetsClient client.
func NewAvailabilitySetsClientWithBaseURI(baseURI string, subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClientWithBaseURI creates an instance of the AvailabilitySetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AvailabilitySetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (result AvailabilitySet, err error)
CreateOrUpdate create or update an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set. parameters - parameters supplied to the Create Availability Set operation.
func (client AvailabilitySetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AvailabilitySetsClient) CreateOrUpdateResponder(resp *http.Response) (result AvailabilitySet, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) Delete(ctx context.Context, resourceGroupName string, availabilitySetName string) (result 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.
func (client AvailabilitySetsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) Get(ctx context.Context, resourceGroupName string, availabilitySetName string) (result AvailabilitySet, err error)
Get retrieves information about an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.
func (client AvailabilitySetsClient) GetPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AvailabilitySetsClient) GetResponder(resp *http.Response) (result AvailabilitySet, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) List(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultPage, err error)
List lists all availability sets in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client AvailabilitySetsClient) ListAvailableSizes(ctx context.Context, resourceGroupName string, availabilitySetName string) (result VirtualMachineSizeListResult, err error)
ListAvailableSizes lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.
func (client AvailabilitySetsClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
ListAvailableSizesPreparer prepares the ListAvailableSizes request.
func (client AvailabilitySetsClient) ListAvailableSizesResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)
ListAvailableSizesResponder handles the response to the ListAvailableSizes request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) ListAvailableSizesSender(req *http.Request) (*http.Response, error)
ListAvailableSizesSender sends the ListAvailableSizes request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) ListBySubscription(ctx context.Context, expand string) (result AvailabilitySetListResultPage, err error)
ListBySubscription lists all availability sets in a subscription. Parameters: expand - the expand expression to apply to the operation. Allowed values are 'instanceView'.
func (client AvailabilitySetsClient) ListBySubscriptionComplete(ctx context.Context, expand string) (result AvailabilitySetListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListBySubscriptionPreparer(ctx context.Context, expand string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client AvailabilitySetsClient) ListBySubscriptionResponder(resp *http.Response) (result AvailabilitySetListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client AvailabilitySetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client AvailabilitySetsClient) ListResponder(resp *http.Response) (result AvailabilitySetListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client AvailabilitySetsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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.
func (client AvailabilitySetsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
AvailablePatchSummary describes the properties of an virtual machine instance view for available patch summary.
type AvailablePatchSummary struct {
// Status - READ-ONLY; The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings.". Possible values include: 'PatchOperationStatusUnknown', 'PatchOperationStatusInProgress', 'PatchOperationStatusFailed', 'PatchOperationStatusSucceeded', 'PatchOperationStatusCompletedWithWarnings'
Status PatchOperationStatus `json:"status,omitempty"`
// AssessmentActivityID - READ-ONLY; The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
AssessmentActivityID *string `json:"assessmentActivityId,omitempty"`
// RebootPending - READ-ONLY; The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.
RebootPending *bool `json:"rebootPending,omitempty"`
// CriticalAndSecurityPatchCount - READ-ONLY; The number of critical or security patches that have been detected as available and not yet installed.
CriticalAndSecurityPatchCount *int32 `json:"criticalAndSecurityPatchCount,omitempty"`
// OtherPatchCount - READ-ONLY; The number of all available patches excluding critical and security.
OtherPatchCount *int32 `json:"otherPatchCount,omitempty"`
// StartTime - READ-ONLY; The UTC timestamp when the operation began.
StartTime *date.Time `json:"startTime,omitempty"`
// LastModifiedTime - READ-ONLY; The UTC timestamp when the operation began.
LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
// Error - READ-ONLY; The errors that were encountered during execution of the operation. The details array contains the list of them.
Error *APIError `json:"error,omitempty"`
}
func (aps AvailablePatchSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailablePatchSummary.
BaseClient is the base client for Compute.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
BillingProfile specifies the billing related details of a Azure Spot VM or VMSS. <br><br>Minimum api-version: 2019-03-01.
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"`
}
BootDiagnostics boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.
type BootDiagnostics struct {
// Enabled - Whether boot diagnostics should be enabled on the Virtual Machine.
Enabled *bool `json:"enabled,omitempty"`
// StorageURI - Uri of the storage account to use for placing the console output and screenshot. <br><br>If storageUri is not specified while enabling boot diagnostics, managed storage will be used.
StorageURI *string `json:"storageUri,omitempty"`
}
BootDiagnosticsInstanceView the instance view of a virtual machine boot diagnostics.
type BootDiagnosticsInstanceView struct {
// ConsoleScreenshotBlobURI - READ-ONLY; The console screenshot blob URI. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage.
ConsoleScreenshotBlobURI *string `json:"consoleScreenshotBlobUri,omitempty"`
// SerialConsoleLogBlobURI - READ-ONLY; The serial console log blob Uri. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage.
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"`
}
func (bdiv BootDiagnosticsInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BootDiagnosticsInstanceView.
CachingTypes enumerates the values for caching types.
type CachingTypes string
const (
// CachingTypesNone ...
CachingTypesNone CachingTypes = "None"
// CachingTypesReadOnly ...
CachingTypesReadOnly CachingTypes = "ReadOnly"
// CachingTypesReadWrite ...
CachingTypesReadWrite CachingTypes = "ReadWrite"
)
func PossibleCachingTypesValues() []CachingTypes
PossibleCachingTypesValues returns an array of possible values for the CachingTypes const type.
CapacityReservation specifies information about the capacity reservation.
type CapacityReservation struct {
autorest.Response `json:"-"`
*CapacityReservationProperties `json:"properties,omitempty"`
// Sku - SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
Sku *Sku `json:"sku,omitempty"`
// Zones - Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in 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"`
}
func (cr CapacityReservation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservation.
func (cr *CapacityReservation) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CapacityReservation struct.
CapacityReservationGroup specifies information about the capacity reservation group that the capacity reservations should be assigned to. <br><br> Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.
type CapacityReservationGroup struct {
autorest.Response `json:"-"`
*CapacityReservationGroupProperties `json:"properties,omitempty"`
// Zones - Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
Zones *[]string `json:"zones,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (crg CapacityReservationGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationGroup.
func (crg *CapacityReservationGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CapacityReservationGroup struct.
CapacityReservationGroupInstanceView ...
type CapacityReservationGroupInstanceView struct {
// CapacityReservations - READ-ONLY; List of instance view of the capacity reservations under the capacity reservation group.
CapacityReservations *[]CapacityReservationInstanceViewWithName `json:"capacityReservations,omitempty"`
}
func (crgiv CapacityReservationGroupInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationGroupInstanceView.
CapacityReservationGroupInstanceViewTypes enumerates the values for capacity reservation group instance view types.
type CapacityReservationGroupInstanceViewTypes string
const (
// CapacityReservationGroupInstanceViewTypesInstanceView ...
CapacityReservationGroupInstanceViewTypesInstanceView CapacityReservationGroupInstanceViewTypes = "instanceView"
)
func PossibleCapacityReservationGroupInstanceViewTypesValues() []CapacityReservationGroupInstanceViewTypes
PossibleCapacityReservationGroupInstanceViewTypesValues returns an array of possible values for the CapacityReservationGroupInstanceViewTypes const type.
CapacityReservationGroupListResult the List capacity reservation group with resource group response.
type CapacityReservationGroupListResult struct {
autorest.Response `json:"-"`
// Value - The list of capacity reservation groups
Value *[]CapacityReservationGroup `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups.
NextLink *string `json:"nextLink,omitempty"`
}
func (crglr CapacityReservationGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CapacityReservationGroupListResultIterator provides access to a complete listing of CapacityReservationGroup values.
type CapacityReservationGroupListResultIterator struct {
// contains filtered or unexported fields
}
func NewCapacityReservationGroupListResultIterator(page CapacityReservationGroupListResultPage) CapacityReservationGroupListResultIterator
Creates a new instance of the CapacityReservationGroupListResultIterator type.
func (iter *CapacityReservationGroupListResultIterator) 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 *CapacityReservationGroupListResultIterator) 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 CapacityReservationGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CapacityReservationGroupListResultIterator) Response() CapacityReservationGroupListResult
Response returns the raw server response from the last page request.
func (iter CapacityReservationGroupListResultIterator) Value() CapacityReservationGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CapacityReservationGroupListResultPage contains a page of CapacityReservationGroup values.
type CapacityReservationGroupListResultPage struct {
// contains filtered or unexported fields
}
func NewCapacityReservationGroupListResultPage(cur CapacityReservationGroupListResult, getNextPage func(context.Context, CapacityReservationGroupListResult) (CapacityReservationGroupListResult, error)) CapacityReservationGroupListResultPage
Creates a new instance of the CapacityReservationGroupListResultPage type.
func (page *CapacityReservationGroupListResultPage) 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 *CapacityReservationGroupListResultPage) 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 CapacityReservationGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CapacityReservationGroupListResultPage) Response() CapacityReservationGroupListResult
Response returns the raw server response from the last page request.
func (page CapacityReservationGroupListResultPage) Values() []CapacityReservationGroup
Values returns the slice of values for the current page or nil if there are no values.
CapacityReservationGroupProperties capacity reservation group Properties.
type CapacityReservationGroupProperties struct {
// CapacityReservations - READ-ONLY; A list of all capacity reservation resource ids that belong to capacity reservation group.
CapacityReservations *[]SubResourceReadOnly `json:"capacityReservations,omitempty"`
// VirtualMachinesAssociated - READ-ONLY; A list of references to all virtual machines associated to the capacity reservation group.
VirtualMachinesAssociated *[]SubResourceReadOnly `json:"virtualMachinesAssociated,omitempty"`
// InstanceView - READ-ONLY; The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
InstanceView *CapacityReservationGroupInstanceView `json:"instanceView,omitempty"`
}
func (crgp CapacityReservationGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationGroupProperties.
CapacityReservationGroupUpdate specifies information about the capacity reservation group. Only tags can be updated.
type CapacityReservationGroupUpdate struct {
*CapacityReservationGroupProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (crgu CapacityReservationGroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationGroupUpdate.
func (crgu *CapacityReservationGroupUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CapacityReservationGroupUpdate struct.
CapacityReservationGroupsClient is the compute Client
type CapacityReservationGroupsClient struct {
BaseClient
}
func NewCapacityReservationGroupsClient(subscriptionID string) CapacityReservationGroupsClient
NewCapacityReservationGroupsClient creates an instance of the CapacityReservationGroupsClient client.
func NewCapacityReservationGroupsClientWithBaseURI(baseURI string, subscriptionID string) CapacityReservationGroupsClient
NewCapacityReservationGroupsClientWithBaseURI creates an instance of the CapacityReservationGroupsClient 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 CapacityReservationGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, parameters CapacityReservationGroup) (result CapacityReservationGroup, err error)
CreateOrUpdate the operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags may be modified. Please refer to https://aka.ms/CapacityReservation for more details. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. parameters - parameters supplied to the Create capacity reservation Group.
func (client CapacityReservationGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, parameters CapacityReservationGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CapacityReservationGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result CapacityReservationGroup, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CapacityReservationGroupsClient) 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 CapacityReservationGroupsClient) Delete(ctx context.Context, resourceGroupName string, capacityReservationGroupName string) (result autorest.Response, err error)
Delete the operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group.
func (client CapacityReservationGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CapacityReservationGroupsClient) 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 CapacityReservationGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationGroupsClient) Get(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, expand CapacityReservationGroupInstanceViewTypes) (result CapacityReservationGroup, err error)
Get the operation that retrieves information about a capacity reservation group. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. expand - the expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.
func (client CapacityReservationGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, expand CapacityReservationGroupInstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CapacityReservationGroupsClient) GetResponder(resp *http.Response) (result CapacityReservationGroup, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CapacityReservationGroupsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand ExpandTypesForGetCapacityReservationGroups) (result CapacityReservationGroupListResultPage, err error)
ListByResourceGroup lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups. Parameters: resourceGroupName - the name of the resource group. expand - the expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.
func (client CapacityReservationGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand ExpandTypesForGetCapacityReservationGroups) (result CapacityReservationGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client CapacityReservationGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand ExpandTypesForGetCapacityReservationGroups) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client CapacityReservationGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result CapacityReservationGroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client CapacityReservationGroupsClient) 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 CapacityReservationGroupsClient) ListBySubscription(ctx context.Context, expand ExpandTypesForGetCapacityReservationGroups) (result CapacityReservationGroupListResultPage, err error)
ListBySubscription lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups. Parameters: expand - the expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.
func (client CapacityReservationGroupsClient) ListBySubscriptionComplete(ctx context.Context, expand ExpandTypesForGetCapacityReservationGroups) (result CapacityReservationGroupListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client CapacityReservationGroupsClient) ListBySubscriptionPreparer(ctx context.Context, expand ExpandTypesForGetCapacityReservationGroups) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client CapacityReservationGroupsClient) ListBySubscriptionResponder(resp *http.Response) (result CapacityReservationGroupListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client CapacityReservationGroupsClient) 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 CapacityReservationGroupsClient) Update(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, parameters CapacityReservationGroupUpdate) (result CapacityReservationGroup, err error)
Update the operation to update a capacity reservation group. When updating a capacity reservation group, only tags may be modified. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. parameters - parameters supplied to the Update capacity reservation Group operation.
func (client CapacityReservationGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, parameters CapacityReservationGroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CapacityReservationGroupsClient) UpdateResponder(resp *http.Response) (result CapacityReservationGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client CapacityReservationGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CapacityReservationInstanceView the instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.
type CapacityReservationInstanceView struct {
// UtilizationInfo - Unutilized capacity of the capacity reservation.
UtilizationInfo *CapacityReservationUtilization `json:"utilizationInfo,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
CapacityReservationInstanceViewTypes enumerates the values for capacity reservation instance view types.
type CapacityReservationInstanceViewTypes string
const (
// CapacityReservationInstanceViewTypesInstanceView ...
CapacityReservationInstanceViewTypesInstanceView CapacityReservationInstanceViewTypes = "instanceView"
)
func PossibleCapacityReservationInstanceViewTypesValues() []CapacityReservationInstanceViewTypes
PossibleCapacityReservationInstanceViewTypesValues returns an array of possible values for the CapacityReservationInstanceViewTypes const type.
CapacityReservationInstanceViewWithName the instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.
type CapacityReservationInstanceViewWithName struct {
// Name - READ-ONLY; The name of the capacity reservation.
Name *string `json:"name,omitempty"`
// UtilizationInfo - Unutilized capacity of the capacity reservation.
UtilizationInfo *CapacityReservationUtilization `json:"utilizationInfo,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
func (crivwn CapacityReservationInstanceViewWithName) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationInstanceViewWithName.
CapacityReservationListResult the list capacity reservation operation response.
type CapacityReservationListResult struct {
autorest.Response `json:"-"`
// Value - The list of capacity reservations
Value *[]CapacityReservation `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations.
NextLink *string `json:"nextLink,omitempty"`
}
func (crlr CapacityReservationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CapacityReservationListResultIterator provides access to a complete listing of CapacityReservation values.
type CapacityReservationListResultIterator struct {
// contains filtered or unexported fields
}
func NewCapacityReservationListResultIterator(page CapacityReservationListResultPage) CapacityReservationListResultIterator
Creates a new instance of the CapacityReservationListResultIterator type.
func (iter *CapacityReservationListResultIterator) 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 *CapacityReservationListResultIterator) 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 CapacityReservationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CapacityReservationListResultIterator) Response() CapacityReservationListResult
Response returns the raw server response from the last page request.
func (iter CapacityReservationListResultIterator) Value() CapacityReservation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CapacityReservationListResultPage contains a page of CapacityReservation values.
type CapacityReservationListResultPage struct {
// contains filtered or unexported fields
}
func NewCapacityReservationListResultPage(cur CapacityReservationListResult, getNextPage func(context.Context, CapacityReservationListResult) (CapacityReservationListResult, error)) CapacityReservationListResultPage
Creates a new instance of the CapacityReservationListResultPage type.
func (page *CapacityReservationListResultPage) 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 *CapacityReservationListResultPage) 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 CapacityReservationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CapacityReservationListResultPage) Response() CapacityReservationListResult
Response returns the raw server response from the last page request.
func (page CapacityReservationListResultPage) Values() []CapacityReservation
Values returns the slice of values for the current page or nil if there are no values.
CapacityReservationProfile the parameters of a capacity reservation Profile.
type CapacityReservationProfile struct {
// CapacityReservationGroup - Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.
CapacityReservationGroup *SubResource `json:"capacityReservationGroup,omitempty"`
}
CapacityReservationProperties properties of the Capacity reservation.
type CapacityReservationProperties struct {
// ReservationID - READ-ONLY; A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
ReservationID *string `json:"reservationId,omitempty"`
// VirtualMachinesAssociated - READ-ONLY; A list of all virtual machine resource ids that are associated with the capacity reservation.
VirtualMachinesAssociated *[]SubResourceReadOnly `json:"virtualMachinesAssociated,omitempty"`
// ProvisioningTime - READ-ONLY; The date time when the capacity reservation was last updated.
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 Capacity reservation instance view.
InstanceView *CapacityReservationInstanceView `json:"instanceView,omitempty"`
// TimeCreated - READ-ONLY; Specifies the time at which the Capacity Reservation resource was created.<br><br>Minimum api-version: 2021-11-01.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
}
func (crp CapacityReservationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationProperties.
CapacityReservationUpdate specifies information about the capacity reservation. Only tags and sku.capacity can be updated.
type CapacityReservationUpdate struct {
*CapacityReservationProperties `json:"properties,omitempty"`
// Sku - SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
Sku *Sku `json:"sku,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (cru CapacityReservationUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationUpdate.
func (cru *CapacityReservationUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CapacityReservationUpdate struct.
CapacityReservationUtilization represents the capacity reservation utilization in terms of resources allocated.
type CapacityReservationUtilization struct {
// VirtualMachinesAllocated - READ-ONLY; A list of all virtual machines resource ids allocated against the capacity reservation.
VirtualMachinesAllocated *[]SubResourceReadOnly `json:"virtualMachinesAllocated,omitempty"`
}
func (cru CapacityReservationUtilization) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CapacityReservationUtilization.
CapacityReservationsClient is the compute Client
type CapacityReservationsClient struct {
BaseClient
}
func NewCapacityReservationsClient(subscriptionID string) CapacityReservationsClient
NewCapacityReservationsClient creates an instance of the CapacityReservationsClient client.
func NewCapacityReservationsClientWithBaseURI(baseURI string, subscriptionID string) CapacityReservationsClient
NewCapacityReservationsClientWithBaseURI creates an instance of the CapacityReservationsClient 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 CapacityReservationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, parameters CapacityReservation) (result CapacityReservationsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to https://aka.ms/CapacityReservation for more details. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. capacityReservationName - the name of the capacity reservation. parameters - parameters supplied to the Create capacity reservation.
func (client CapacityReservationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, parameters CapacityReservation) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CapacityReservationsClient) CreateOrUpdateResponder(resp *http.Response) (result CapacityReservation, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CapacityReservationsClient) CreateOrUpdateSender(req *http.Request) (future CapacityReservationsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationsClient) Delete(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string) (result CapacityReservationsDeleteFuture, err error)
Delete the operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. Please refer to https://aka.ms/CapacityReservation for more details. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. capacityReservationName - the name of the capacity reservation.
func (client CapacityReservationsClient) DeletePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CapacityReservationsClient) 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 CapacityReservationsClient) DeleteSender(req *http.Request) (future CapacityReservationsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationsClient) Get(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, expand CapacityReservationInstanceViewTypes) (result CapacityReservation, err error)
Get the operation that retrieves information about the capacity reservation. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. capacityReservationName - the name of the capacity reservation. expand - the expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.
func (client CapacityReservationsClient) GetPreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, expand CapacityReservationInstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CapacityReservationsClient) GetResponder(resp *http.Response) (result CapacityReservation, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CapacityReservationsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationsClient) ListByCapacityReservationGroup(ctx context.Context, resourceGroupName string, capacityReservationGroupName string) (result CapacityReservationListResultPage, err error)
ListByCapacityReservationGroup lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group.
func (client CapacityReservationsClient) ListByCapacityReservationGroupComplete(ctx context.Context, resourceGroupName string, capacityReservationGroupName string) (result CapacityReservationListResultIterator, err error)
ListByCapacityReservationGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client CapacityReservationsClient) ListByCapacityReservationGroupPreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string) (*http.Request, error)
ListByCapacityReservationGroupPreparer prepares the ListByCapacityReservationGroup request.
func (client CapacityReservationsClient) ListByCapacityReservationGroupResponder(resp *http.Response) (result CapacityReservationListResult, err error)
ListByCapacityReservationGroupResponder handles the response to the ListByCapacityReservationGroup request. The method always closes the http.Response Body.
func (client CapacityReservationsClient) ListByCapacityReservationGroupSender(req *http.Request) (*http.Response, error)
ListByCapacityReservationGroupSender sends the ListByCapacityReservationGroup request. The method will close the http.Response Body if it receives an error.
func (client CapacityReservationsClient) Update(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, parameters CapacityReservationUpdate) (result CapacityReservationsUpdateFuture, err error)
Update the operation to update a capacity reservation. Parameters: resourceGroupName - the name of the resource group. capacityReservationGroupName - the name of the capacity reservation group. capacityReservationName - the name of the capacity reservation. parameters - parameters supplied to the Update capacity reservation operation.
func (client CapacityReservationsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, capacityReservationGroupName string, capacityReservationName string, parameters CapacityReservationUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CapacityReservationsClient) UpdateResponder(resp *http.Response) (result CapacityReservation, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client CapacityReservationsClient) UpdateSender(req *http.Request) (future CapacityReservationsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CapacityReservationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CapacityReservationsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CapacityReservationsClient) (CapacityReservation, error)
}
func (future *CapacityReservationsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CapacityReservationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CapacityReservationsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CapacityReservationsClient) (autorest.Response, error)
}
func (future *CapacityReservationsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CapacityReservationsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CapacityReservationsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CapacityReservationsClient) (CapacityReservation, error)
}
func (future *CapacityReservationsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudError an error response from the Compute service.
type CloudError struct {
Error *APIError `json:"error,omitempty"`
}
CloudService describes the cloud service.
type CloudService struct {
autorest.Response `json:"-"`
// 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"`
Properties *CloudServiceProperties `json:"properties,omitempty"`
}
func (cs CloudService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudService.
CloudServiceExtensionProfile describes a cloud service extension profile.
type CloudServiceExtensionProfile struct {
// Extensions - List of extensions for the cloud service.
Extensions *[]Extension `json:"extensions,omitempty"`
}
CloudServiceExtensionProperties extension Properties.
type CloudServiceExtensionProperties struct {
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension.
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// Settings - Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.
Settings *string `json:"settings,omitempty"`
// ProtectedSettings - Protected settings for the extension which are encrypted before sent to the role instance.
ProtectedSettings *string `json:"protectedSettings,omitempty"`
ProtectedSettingsFromKeyVault *CloudServiceVaultAndSecretReference `json:"protectedSettingsFromKeyVault,omitempty"`
// ForceUpdateTag - Tag to force apply the provided public and protected settings.
// Changing the tag value allows for re-running the extension without changing any of the public or protected settings.
// If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.
// If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and
// it is up to handler implementation whether to re-run it or not
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// RolesAppliedTo - Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.
RolesAppliedTo *[]string `json:"rolesAppliedTo,omitempty"`
}
func (csep CloudServiceExtensionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceExtensionProperties.
CloudServiceInstanceView instanceView of CloudService as a whole
type CloudServiceInstanceView struct {
autorest.Response `json:"-"`
RoleInstance *InstanceViewStatusesSummary `json:"roleInstance,omitempty"`
// SdkVersion - READ-ONLY; The version of the SDK that was used to generate the package for the cloud service.
SdkVersion *string `json:"sdkVersion,omitempty"`
// PrivateIds - READ-ONLY; Specifies a list of unique identifiers generated internally for the cloud service. <br /><br /> NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.
PrivateIds *[]string `json:"privateIds,omitempty"`
// Statuses - READ-ONLY
Statuses *[]ResourceInstanceViewStatus `json:"statuses,omitempty"`
}
func (csiv CloudServiceInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceInstanceView.
CloudServiceListResult ...
type CloudServiceListResult struct {
autorest.Response `json:"-"`
Value *[]CloudService `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (cslr CloudServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CloudServiceListResultIterator provides access to a complete listing of CloudService values.
type CloudServiceListResultIterator struct {
// contains filtered or unexported fields
}
func NewCloudServiceListResultIterator(page CloudServiceListResultPage) CloudServiceListResultIterator
Creates a new instance of the CloudServiceListResultIterator type.
func (iter *CloudServiceListResultIterator) 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 *CloudServiceListResultIterator) 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 CloudServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudServiceListResultIterator) Response() CloudServiceListResult
Response returns the raw server response from the last page request.
func (iter CloudServiceListResultIterator) Value() CloudService
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CloudServiceListResultPage contains a page of CloudService values.
type CloudServiceListResultPage struct {
// contains filtered or unexported fields
}
func NewCloudServiceListResultPage(cur CloudServiceListResult, getNextPage func(context.Context, CloudServiceListResult) (CloudServiceListResult, error)) CloudServiceListResultPage
Creates a new instance of the CloudServiceListResultPage type.
func (page *CloudServiceListResultPage) 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 *CloudServiceListResultPage) 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 CloudServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudServiceListResultPage) Response() CloudServiceListResult
Response returns the raw server response from the last page request.
func (page CloudServiceListResultPage) Values() []CloudService
Values returns the slice of values for the current page or nil if there are no values.
CloudServiceNetworkProfile network Profile for the cloud service.
type CloudServiceNetworkProfile struct {
// LoadBalancerConfigurations - List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.
LoadBalancerConfigurations *[]LoadBalancerConfiguration `json:"loadBalancerConfigurations,omitempty"`
// SwappableCloudService - The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.
SwappableCloudService *SubResource `json:"swappableCloudService,omitempty"`
}
CloudServiceOperatingSystemsClient is the compute Client
type CloudServiceOperatingSystemsClient struct {
BaseClient
}
func NewCloudServiceOperatingSystemsClient(subscriptionID string) CloudServiceOperatingSystemsClient
NewCloudServiceOperatingSystemsClient creates an instance of the CloudServiceOperatingSystemsClient client.
func NewCloudServiceOperatingSystemsClientWithBaseURI(baseURI string, subscriptionID string) CloudServiceOperatingSystemsClient
NewCloudServiceOperatingSystemsClientWithBaseURI creates an instance of the CloudServiceOperatingSystemsClient 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 CloudServiceOperatingSystemsClient) GetOSFamily(ctx context.Context, location string, osFamilyName string) (result OSFamily, err error)
GetOSFamily gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service. Parameters: location - name of the location that the OS family pertains to. osFamilyName - name of the OS family.
func (client CloudServiceOperatingSystemsClient) GetOSFamilyPreparer(ctx context.Context, location string, osFamilyName string) (*http.Request, error)
GetOSFamilyPreparer prepares the GetOSFamily request.
func (client CloudServiceOperatingSystemsClient) GetOSFamilyResponder(resp *http.Response) (result OSFamily, err error)
GetOSFamilyResponder handles the response to the GetOSFamily request. The method always closes the http.Response Body.
func (client CloudServiceOperatingSystemsClient) GetOSFamilySender(req *http.Request) (*http.Response, error)
GetOSFamilySender sends the GetOSFamily request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceOperatingSystemsClient) GetOSVersion(ctx context.Context, location string, osVersionName string) (result OSVersion, err error)
GetOSVersion gets properties of a guest operating system version that can be specified in the XML service configuration (.cscfg) for a cloud service. Parameters: location - name of the location that the OS version pertains to. osVersionName - name of the OS version.
func (client CloudServiceOperatingSystemsClient) GetOSVersionPreparer(ctx context.Context, location string, osVersionName string) (*http.Request, error)
GetOSVersionPreparer prepares the GetOSVersion request.
func (client CloudServiceOperatingSystemsClient) GetOSVersionResponder(resp *http.Response) (result OSVersion, err error)
GetOSVersionResponder handles the response to the GetOSVersion request. The method always closes the http.Response Body.
func (client CloudServiceOperatingSystemsClient) GetOSVersionSender(req *http.Request) (*http.Response, error)
GetOSVersionSender sends the GetOSVersion request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceOperatingSystemsClient) ListOSFamilies(ctx context.Context, location string) (result OSFamilyListResultPage, err error)
ListOSFamilies gets a list of all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink property in the response to get the next page of OS Families. Do this till nextLink is null to fetch all the OS Families. Parameters: location - name of the location that the OS families pertain to.
func (client CloudServiceOperatingSystemsClient) ListOSFamiliesComplete(ctx context.Context, location string) (result OSFamilyListResultIterator, err error)
ListOSFamiliesComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServiceOperatingSystemsClient) ListOSFamiliesPreparer(ctx context.Context, location string) (*http.Request, error)
ListOSFamiliesPreparer prepares the ListOSFamilies request.
func (client CloudServiceOperatingSystemsClient) ListOSFamiliesResponder(resp *http.Response) (result OSFamilyListResult, err error)
ListOSFamiliesResponder handles the response to the ListOSFamilies request. The method always closes the http.Response Body.
func (client CloudServiceOperatingSystemsClient) ListOSFamiliesSender(req *http.Request) (*http.Response, error)
ListOSFamiliesSender sends the ListOSFamilies request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceOperatingSystemsClient) ListOSVersions(ctx context.Context, location string) (result OSVersionListResultPage, err error)
ListOSVersions gets a list of all guest operating system versions available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink property in the response to get the next page of OS versions. Do this till nextLink is null to fetch all the OS versions. Parameters: location - name of the location that the OS versions pertain to.
func (client CloudServiceOperatingSystemsClient) ListOSVersionsComplete(ctx context.Context, location string) (result OSVersionListResultIterator, err error)
ListOSVersionsComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServiceOperatingSystemsClient) ListOSVersionsPreparer(ctx context.Context, location string) (*http.Request, error)
ListOSVersionsPreparer prepares the ListOSVersions request.
func (client CloudServiceOperatingSystemsClient) ListOSVersionsResponder(resp *http.Response) (result OSVersionListResult, err error)
ListOSVersionsResponder handles the response to the ListOSVersions request. The method always closes the http.Response Body.
func (client CloudServiceOperatingSystemsClient) ListOSVersionsSender(req *http.Request) (*http.Response, error)
ListOSVersionsSender sends the ListOSVersions request. The method will close the http.Response Body if it receives an error.
CloudServiceOsProfile describes the OS profile for the cloud service.
type CloudServiceOsProfile struct {
// Secrets - Specifies set of certificates that should be installed onto the role instances.
Secrets *[]CloudServiceVaultSecretGroup `json:"secrets,omitempty"`
}
CloudServiceProperties cloud service properties
type CloudServiceProperties struct {
// PackageURL - Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.
// This is a write-only property and is not returned in GET calls.
PackageURL *string `json:"packageUrl,omitempty"`
// Configuration - Specifies the XML service configuration (.cscfg) for the cloud service.
Configuration *string `json:"configuration,omitempty"`
// ConfigurationURL - Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.
// This is a write-only property and is not returned in GET calls.
ConfigurationURL *string `json:"configurationUrl,omitempty"`
// StartCloudService - (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.
// If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.
StartCloudService *bool `json:"startCloudService,omitempty"`
// AllowModelOverride - (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.
// The default value is `false`.
AllowModelOverride *bool `json:"allowModelOverride,omitempty"`
// UpgradeMode - Possible values include: 'CloudServiceUpgradeModeAuto', 'CloudServiceUpgradeModeManual', 'CloudServiceUpgradeModeSimultaneous'
UpgradeMode CloudServiceUpgradeMode `json:"upgradeMode,omitempty"`
RoleProfile *CloudServiceRoleProfile `json:"roleProfile,omitempty"`
OsProfile *CloudServiceOsProfile `json:"osProfile,omitempty"`
NetworkProfile *CloudServiceNetworkProfile `json:"networkProfile,omitempty"`
ExtensionProfile *CloudServiceExtensionProfile `json:"extensionProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueID - READ-ONLY; The unique identifier for the cloud service.
UniqueID *string `json:"uniqueId,omitempty"`
}
func (csp CloudServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceProperties.
CloudServiceRole describes a role of the cloud service.
type CloudServiceRole struct {
autorest.Response `json:"-"`
// 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 - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
Sku *CloudServiceRoleSku `json:"sku,omitempty"`
Properties *CloudServiceRoleProperties `json:"properties,omitempty"`
}
func (csr CloudServiceRole) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceRole.
CloudServiceRoleInstancesClient is the compute Client
type CloudServiceRoleInstancesClient struct {
BaseClient
}
func NewCloudServiceRoleInstancesClient(subscriptionID string) CloudServiceRoleInstancesClient
NewCloudServiceRoleInstancesClient creates an instance of the CloudServiceRoleInstancesClient client.
func NewCloudServiceRoleInstancesClientWithBaseURI(baseURI string, subscriptionID string) CloudServiceRoleInstancesClient
NewCloudServiceRoleInstancesClientWithBaseURI creates an instance of the CloudServiceRoleInstancesClient 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 CloudServiceRoleInstancesClient) Delete(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleInstancesDeleteFuture, err error)
Delete deletes a role instance from a cloud service. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) DeletePreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CloudServiceRoleInstancesClient) 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 CloudServiceRoleInstancesClient) DeleteSender(req *http.Request) (future CloudServiceRoleInstancesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) Get(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string, expand InstanceViewTypes) (result RoleInstance, err error)
Get gets a role instance from a cloud service. Parameters: roleInstanceName - name of the role instance. expand - the expand expression to apply to the operation. 'UserData' is not supported for cloud services.
func (client CloudServiceRoleInstancesClient) GetInstanceView(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result RoleInstanceInstanceView, err error)
GetInstanceView retrieves information about the run-time state of a role instance in a cloud service. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) GetInstanceViewPreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client CloudServiceRoleInstancesClient) GetInstanceViewResponder(resp *http.Response) (result RoleInstanceInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) GetPreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string, expand InstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CloudServiceRoleInstancesClient) GetRemoteDesktopFile(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result ReadCloser, err error)
GetRemoteDesktopFile gets a remote desktop file for a role instance in a cloud service. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) GetRemoteDesktopFilePreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
GetRemoteDesktopFilePreparer prepares the GetRemoteDesktopFile request.
func (client CloudServiceRoleInstancesClient) GetRemoteDesktopFileResponder(resp *http.Response) (result ReadCloser, err error)
GetRemoteDesktopFileResponder handles the response to the GetRemoteDesktopFile request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) GetRemoteDesktopFileSender(req *http.Request) (*http.Response, error)
GetRemoteDesktopFileSender sends the GetRemoteDesktopFile request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) GetResponder(resp *http.Response) (result RoleInstance, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) List(ctx context.Context, resourceGroupName string, cloudServiceName string, expand InstanceViewTypes) (result RoleInstanceListResultPage, err error)
List gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances. Parameters: expand - the expand expression to apply to the operation. 'UserData' is not supported for cloud services.
func (client CloudServiceRoleInstancesClient) ListComplete(ctx context.Context, resourceGroupName string, cloudServiceName string, expand InstanceViewTypes) (result RoleInstanceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServiceRoleInstancesClient) ListPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, expand InstanceViewTypes) (*http.Request, error)
ListPreparer prepares the List request.
func (client CloudServiceRoleInstancesClient) ListResponder(resp *http.Response) (result RoleInstanceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) Rebuild(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleInstancesRebuildFuture, err error)
Rebuild the Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) RebuildPreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
RebuildPreparer prepares the Rebuild request.
func (client CloudServiceRoleInstancesClient) RebuildResponder(resp *http.Response) (result autorest.Response, err error)
RebuildResponder handles the response to the Rebuild request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) RebuildSender(req *http.Request) (future CloudServiceRoleInstancesRebuildFuture, err error)
RebuildSender sends the Rebuild request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) Reimage(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleInstancesReimageFuture, err error)
Reimage the Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) ReimagePreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client CloudServiceRoleInstancesClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) ReimageSender(req *http.Request) (future CloudServiceRoleInstancesReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRoleInstancesClient) Restart(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleInstancesRestartFuture, err error)
Restart the Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service. Parameters: roleInstanceName - name of the role instance.
func (client CloudServiceRoleInstancesClient) RestartPreparer(ctx context.Context, roleInstanceName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client CloudServiceRoleInstancesClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client CloudServiceRoleInstancesClient) RestartSender(req *http.Request) (future CloudServiceRoleInstancesRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
CloudServiceRoleInstancesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServiceRoleInstancesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServiceRoleInstancesClient) (autorest.Response, error)
}
func (future *CloudServiceRoleInstancesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServiceRoleInstancesRebuildFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServiceRoleInstancesRebuildFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServiceRoleInstancesClient) (autorest.Response, error)
}
func (future *CloudServiceRoleInstancesRebuildFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServiceRoleInstancesReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServiceRoleInstancesReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServiceRoleInstancesClient) (autorest.Response, error)
}
func (future *CloudServiceRoleInstancesReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServiceRoleInstancesRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServiceRoleInstancesRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServiceRoleInstancesClient) (autorest.Response, error)
}
func (future *CloudServiceRoleInstancesRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServiceRoleListResult ...
type CloudServiceRoleListResult struct {
autorest.Response `json:"-"`
Value *[]CloudServiceRole `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (csrlr CloudServiceRoleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CloudServiceRoleListResultIterator provides access to a complete listing of CloudServiceRole values.
type CloudServiceRoleListResultIterator struct {
// contains filtered or unexported fields
}
func NewCloudServiceRoleListResultIterator(page CloudServiceRoleListResultPage) CloudServiceRoleListResultIterator
Creates a new instance of the CloudServiceRoleListResultIterator type.
func (iter *CloudServiceRoleListResultIterator) 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 *CloudServiceRoleListResultIterator) 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 CloudServiceRoleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudServiceRoleListResultIterator) Response() CloudServiceRoleListResult
Response returns the raw server response from the last page request.
func (iter CloudServiceRoleListResultIterator) Value() CloudServiceRole
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CloudServiceRoleListResultPage contains a page of CloudServiceRole values.
type CloudServiceRoleListResultPage struct {
// contains filtered or unexported fields
}
func NewCloudServiceRoleListResultPage(cur CloudServiceRoleListResult, getNextPage func(context.Context, CloudServiceRoleListResult) (CloudServiceRoleListResult, error)) CloudServiceRoleListResultPage
Creates a new instance of the CloudServiceRoleListResultPage type.
func (page *CloudServiceRoleListResultPage) 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 *CloudServiceRoleListResultPage) 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 CloudServiceRoleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudServiceRoleListResultPage) Response() CloudServiceRoleListResult
Response returns the raw server response from the last page request.
func (page CloudServiceRoleListResultPage) Values() []CloudServiceRole
Values returns the slice of values for the current page or nil if there are no values.
CloudServiceRoleProfile describes the role profile for the cloud service.
type CloudServiceRoleProfile struct {
// Roles - List of roles for the cloud service.
Roles *[]CloudServiceRoleProfileProperties `json:"roles,omitempty"`
}
CloudServiceRoleProfileProperties describes the role properties.
type CloudServiceRoleProfileProperties struct {
// Name - Resource name.
Name *string `json:"name,omitempty"`
Sku *CloudServiceRoleSku `json:"sku,omitempty"`
}
CloudServiceRoleProperties ...
type CloudServiceRoleProperties struct {
// UniqueID - READ-ONLY; Specifies the ID which uniquely identifies a cloud service role.
UniqueID *string `json:"uniqueId,omitempty"`
}
func (csrp CloudServiceRoleProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceRoleProperties.
CloudServiceRoleSku describes the cloud service role sku.
type CloudServiceRoleSku struct {
// Name - The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.
Name *string `json:"name,omitempty"`
// Tier - Specifies the tier of the cloud service. Possible Values are <br /><br /> **Standard** <br /><br /> **Basic**
Tier *string `json:"tier,omitempty"`
// Capacity - Specifies the number of role instances in the cloud service.
Capacity *int64 `json:"capacity,omitempty"`
}
CloudServiceRolesClient is the compute Client
type CloudServiceRolesClient struct {
BaseClient
}
func NewCloudServiceRolesClient(subscriptionID string) CloudServiceRolesClient
NewCloudServiceRolesClient creates an instance of the CloudServiceRolesClient client.
func NewCloudServiceRolesClientWithBaseURI(baseURI string, subscriptionID string) CloudServiceRolesClient
NewCloudServiceRolesClientWithBaseURI creates an instance of the CloudServiceRolesClient 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 CloudServiceRolesClient) Get(ctx context.Context, roleName string, resourceGroupName string, cloudServiceName string) (result CloudServiceRole, err error)
Get gets a role from a cloud service. Parameters: roleName - name of the role.
func (client CloudServiceRolesClient) GetPreparer(ctx context.Context, roleName string, resourceGroupName string, cloudServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CloudServiceRolesClient) GetResponder(resp *http.Response) (result CloudServiceRole, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CloudServiceRolesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CloudServiceRolesClient) List(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleListResultPage, err error)
List gets a list of all roles in a cloud service. Use nextLink property in the response to get the next page of roles. Do this till nextLink is null to fetch all the roles.
func (client CloudServiceRolesClient) ListComplete(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServiceRoleListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServiceRolesClient) ListPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client CloudServiceRolesClient) ListResponder(resp *http.Response) (result CloudServiceRoleListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client CloudServiceRolesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
CloudServiceUpdate ...
type CloudServiceUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (csu CloudServiceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudServiceUpdate.
CloudServiceUpgradeMode enumerates the values for cloud service upgrade mode.
type CloudServiceUpgradeMode string
const (
// CloudServiceUpgradeModeAuto ...
CloudServiceUpgradeModeAuto CloudServiceUpgradeMode = "Auto"
// CloudServiceUpgradeModeManual ...
CloudServiceUpgradeModeManual CloudServiceUpgradeMode = "Manual"
// CloudServiceUpgradeModeSimultaneous ...
CloudServiceUpgradeModeSimultaneous CloudServiceUpgradeMode = "Simultaneous"
)
func PossibleCloudServiceUpgradeModeValues() []CloudServiceUpgradeMode
PossibleCloudServiceUpgradeModeValues returns an array of possible values for the CloudServiceUpgradeMode const type.
CloudServiceVaultAndSecretReference ...
type CloudServiceVaultAndSecretReference struct {
SourceVault *SubResource `json:"sourceVault,omitempty"`
SecretURL *string `json:"secretUrl,omitempty"`
}
CloudServiceVaultCertificate describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance.
type CloudServiceVaultCertificate struct {
// CertificateURL - This is the URL of a certificate that has been uploaded to Key Vault as a secret.
CertificateURL *string `json:"certificateUrl,omitempty"`
}
CloudServiceVaultSecretGroup describes a set of certificates which are all in the same Key Vault.
type CloudServiceVaultSecretGroup struct {
// SourceVault - The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
SourceVault *SubResource `json:"sourceVault,omitempty"`
// VaultCertificates - The list of key vault references in SourceVault which contain certificates.
VaultCertificates *[]CloudServiceVaultCertificate `json:"vaultCertificates,omitempty"`
}
CloudServicesClient is the compute Client
type CloudServicesClient struct {
BaseClient
}
func NewCloudServicesClient(subscriptionID string) CloudServicesClient
NewCloudServicesClient creates an instance of the CloudServicesClient client.
func NewCloudServicesClientWithBaseURI(baseURI string, subscriptionID string) CloudServicesClient
NewCloudServicesClientWithBaseURI creates an instance of the CloudServicesClient 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 CloudServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *CloudService) (result CloudServicesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a cloud service. Please note some properties can be set only during cloud service creation. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - the cloud service object.
func (client CloudServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *CloudService) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CloudServicesClient) CreateOrUpdateResponder(resp *http.Response) (result CloudService, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CloudServicesClient) CreateOrUpdateSender(req *http.Request) (future CloudServicesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Delete(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServicesDeleteFuture, err error)
Delete deletes a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesClient) DeleteInstances(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (result CloudServicesDeleteInstancesFuture, err error)
DeleteInstances deletes role instances in a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - list of cloud service role instance names.
func (client CloudServicesClient) DeleteInstancesPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (*http.Request, error)
DeleteInstancesPreparer prepares the DeleteInstances request.
func (client CloudServicesClient) DeleteInstancesResponder(resp *http.Response) (result autorest.Response, err error)
DeleteInstancesResponder handles the response to the DeleteInstances request. The method always closes the http.Response Body.
func (client CloudServicesClient) DeleteInstancesSender(req *http.Request) (future CloudServicesDeleteInstancesFuture, err error)
DeleteInstancesSender sends the DeleteInstances request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CloudServicesClient) 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 CloudServicesClient) DeleteSender(req *http.Request) (future CloudServicesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Get(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudService, err error)
Get display information about a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesClient) GetInstanceView(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServiceInstanceView, err error)
GetInstanceView gets the status of a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesClient) GetInstanceViewPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client CloudServicesClient) GetInstanceViewResponder(resp *http.Response) (result CloudServiceInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client CloudServicesClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CloudServicesClient) GetResponder(resp *http.Response) (result CloudService, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CloudServicesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) List(ctx context.Context, resourceGroupName string) (result CloudServiceListResultPage, err error)
List gets a list of all cloud services under a resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services. Parameters: resourceGroupName - name of the resource group.
func (client CloudServicesClient) ListAll(ctx context.Context) (result CloudServiceListResultPage, err error)
ListAll gets a list of all cloud services in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.
func (client CloudServicesClient) ListAllComplete(ctx context.Context) (result CloudServiceListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServicesClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client CloudServicesClient) ListAllResponder(resp *http.Response) (result CloudServiceListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client CloudServicesClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) ListComplete(ctx context.Context, resourceGroupName string) (result CloudServiceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServicesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client CloudServicesClient) ListResponder(resp *http.Response) (result CloudServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client CloudServicesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) PowerOff(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServicesPowerOffFuture, err error)
PowerOff power off the cloud service. Note that resources are still attached and you are getting charged for the resources. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client CloudServicesClient) PowerOffResponder(resp *http.Response) (result autorest.Response, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client CloudServicesClient) PowerOffSender(req *http.Request) (future CloudServicesPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Rebuild(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (result CloudServicesRebuildFuture, err error)
Rebuild rebuild Role Instances reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instances. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - list of cloud service role instance names.
func (client CloudServicesClient) RebuildPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (*http.Request, error)
RebuildPreparer prepares the Rebuild request.
func (client CloudServicesClient) RebuildResponder(resp *http.Response) (result autorest.Response, err error)
RebuildResponder handles the response to the Rebuild request. The method always closes the http.Response Body.
func (client CloudServicesClient) RebuildSender(req *http.Request) (future CloudServicesRebuildFuture, err error)
RebuildSender sends the Rebuild request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Reimage(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (result CloudServicesReimageFuture, err error)
Reimage reimage asynchronous operation reinstalls the operating system on instances of web roles or worker roles. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - list of cloud service role instance names.
func (client CloudServicesClient) ReimagePreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client CloudServicesClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client CloudServicesClient) ReimageSender(req *http.Request) (future CloudServicesReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Restart(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (result CloudServicesRestartFuture, err error)
Restart restarts one or more role instances in a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - list of cloud service role instance names.
func (client CloudServicesClient) RestartPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *RoleInstances) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client CloudServicesClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client CloudServicesClient) RestartSender(req *http.Request) (future CloudServicesRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Start(ctx context.Context, resourceGroupName string, cloudServiceName string) (result CloudServicesStartFuture, err error)
Start starts the cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesClient) StartPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client CloudServicesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client CloudServicesClient) StartSender(req *http.Request) (future CloudServicesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesClient) Update(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *CloudServiceUpdate) (result CloudServicesUpdateFuture, err error)
Update update a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. parameters - the cloud service object.
func (client CloudServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, parameters *CloudServiceUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CloudServicesClient) UpdateResponder(resp *http.Response) (result CloudService, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client CloudServicesClient) UpdateSender(req *http.Request) (future CloudServicesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CloudServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (CloudService, error)
}
func (future *CloudServicesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesDeleteInstancesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesDeleteInstancesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesDeleteInstancesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesRebuildFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesRebuildFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesRebuildFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (autorest.Response, error)
}
func (future *CloudServicesStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesUpdateDomainClient is the compute Client
type CloudServicesUpdateDomainClient struct {
BaseClient
}
func NewCloudServicesUpdateDomainClient(subscriptionID string) CloudServicesUpdateDomainClient
NewCloudServicesUpdateDomainClient creates an instance of the CloudServicesUpdateDomainClient client.
func NewCloudServicesUpdateDomainClientWithBaseURI(baseURI string, subscriptionID string) CloudServicesUpdateDomainClient
NewCloudServicesUpdateDomainClientWithBaseURI creates an instance of the CloudServicesUpdateDomainClient 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 CloudServicesUpdateDomainClient) GetUpdateDomain(ctx context.Context, resourceGroupName string, cloudServiceName string, updateDomain int32) (result UpdateDomain, err error)
GetUpdateDomain gets the specified update domain of a cloud service. Use nextLink property in the response to get the next page of update domains. Do this till nextLink is null to fetch all the update domains. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. updateDomain - specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.
func (client CloudServicesUpdateDomainClient) GetUpdateDomainPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, updateDomain int32) (*http.Request, error)
GetUpdateDomainPreparer prepares the GetUpdateDomain request.
func (client CloudServicesUpdateDomainClient) GetUpdateDomainResponder(resp *http.Response) (result UpdateDomain, err error)
GetUpdateDomainResponder handles the response to the GetUpdateDomain request. The method always closes the http.Response Body.
func (client CloudServicesUpdateDomainClient) GetUpdateDomainSender(req *http.Request) (*http.Response, error)
GetUpdateDomainSender sends the GetUpdateDomain request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesUpdateDomainClient) ListUpdateDomains(ctx context.Context, resourceGroupName string, cloudServiceName string) (result UpdateDomainListResultPage, err error)
ListUpdateDomains gets a list of all update domains in a cloud service. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service.
func (client CloudServicesUpdateDomainClient) ListUpdateDomainsComplete(ctx context.Context, resourceGroupName string, cloudServiceName string) (result UpdateDomainListResultIterator, err error)
ListUpdateDomainsComplete enumerates all values, automatically crossing page boundaries as required.
func (client CloudServicesUpdateDomainClient) ListUpdateDomainsPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string) (*http.Request, error)
ListUpdateDomainsPreparer prepares the ListUpdateDomains request.
func (client CloudServicesUpdateDomainClient) ListUpdateDomainsResponder(resp *http.Response) (result UpdateDomainListResult, err error)
ListUpdateDomainsResponder handles the response to the ListUpdateDomains request. The method always closes the http.Response Body.
func (client CloudServicesUpdateDomainClient) ListUpdateDomainsSender(req *http.Request) (*http.Response, error)
ListUpdateDomainsSender sends the ListUpdateDomains request. The method will close the http.Response Body if it receives an error.
func (client CloudServicesUpdateDomainClient) WalkUpdateDomain(ctx context.Context, resourceGroupName string, cloudServiceName string, updateDomain int32, parameters *UpdateDomain) (result CloudServicesUpdateDomainWalkUpdateDomainFuture, err error)
WalkUpdateDomain updates the role instances in the specified update domain. Parameters: resourceGroupName - name of the resource group. cloudServiceName - name of the cloud service. updateDomain - specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on. parameters - the update domain object.
func (client CloudServicesUpdateDomainClient) WalkUpdateDomainPreparer(ctx context.Context, resourceGroupName string, cloudServiceName string, updateDomain int32, parameters *UpdateDomain) (*http.Request, error)
WalkUpdateDomainPreparer prepares the WalkUpdateDomain request.
func (client CloudServicesUpdateDomainClient) WalkUpdateDomainResponder(resp *http.Response) (result autorest.Response, err error)
WalkUpdateDomainResponder handles the response to the WalkUpdateDomain request. The method always closes the http.Response Body.
func (client CloudServicesUpdateDomainClient) WalkUpdateDomainSender(req *http.Request) (future CloudServicesUpdateDomainWalkUpdateDomainFuture, err error)
WalkUpdateDomainSender sends the WalkUpdateDomain request. The method will close the http.Response Body if it receives an error.
CloudServicesUpdateDomainWalkUpdateDomainFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesUpdateDomainWalkUpdateDomainFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesUpdateDomainClient) (autorest.Response, error)
}
func (future *CloudServicesUpdateDomainWalkUpdateDomainFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CloudServicesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudServicesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CloudServicesClient) (CloudService, error)
}
func (future *CloudServicesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CommunityGalleriesClient is the compute Client
type CommunityGalleriesClient struct {
BaseClient
}
func NewCommunityGalleriesClient(subscriptionID string) CommunityGalleriesClient
NewCommunityGalleriesClient creates an instance of the CommunityGalleriesClient client.
func NewCommunityGalleriesClientWithBaseURI(baseURI string, subscriptionID string) CommunityGalleriesClient
NewCommunityGalleriesClientWithBaseURI creates an instance of the CommunityGalleriesClient 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 CommunityGalleriesClient) Get(ctx context.Context, location string, publicGalleryName string) (result CommunityGallery, err error)
Get get a community gallery by gallery public name. Parameters: location - resource location. publicGalleryName - the public name of the community gallery.
func (client CommunityGalleriesClient) GetPreparer(ctx context.Context, location string, publicGalleryName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CommunityGalleriesClient) GetResponder(resp *http.Response) (result CommunityGallery, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CommunityGalleriesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
CommunityGallery specifies information about the Community Gallery that you want to create or update.
type CommunityGallery struct {
autorest.Response `json:"-"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*CommunityGalleryIdentifier `json:"identifier,omitempty"`
}
func (cg CommunityGallery) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommunityGallery.
func (cg *CommunityGallery) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CommunityGallery struct.
CommunityGalleryIdentifier the identifier information of community gallery.
type CommunityGalleryIdentifier struct {
// UniqueID - The unique id of this community gallery.
UniqueID *string `json:"uniqueId,omitempty"`
}
CommunityGalleryImage specifies information about the gallery image definition that you want to create or update.
type CommunityGalleryImage struct {
autorest.Response `json:"-"`
*CommunityGalleryImageProperties `json:"properties,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*CommunityGalleryIdentifier `json:"identifier,omitempty"`
}
func (cgiVar CommunityGalleryImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommunityGalleryImage.
func (cgiVar *CommunityGalleryImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CommunityGalleryImage struct.
CommunityGalleryImageProperties describes the properties of a gallery image definition.
type CommunityGalleryImageProperties struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Possible values include: 'OperatingSystemStateTypesGeneralized', 'OperatingSystemStateTypesSpecialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// EndOfLifeDate - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
Identifier *GalleryImageIdentifier `json:"identifier,omitempty"`
Recommended *RecommendedMachineConfiguration `json:"recommended,omitempty"`
Disallowed *Disallowed `json:"disallowed,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// Features - A list of gallery image features.
Features *[]GalleryImageFeature `json:"features,omitempty"`
PurchasePlan *ImagePurchasePlan `json:"purchasePlan,omitempty"`
}
CommunityGalleryImageVersion specifies information about the gallery image version that you want to create or update.
type CommunityGalleryImageVersion struct {
autorest.Response `json:"-"`
*CommunityGalleryImageVersionProperties `json:"properties,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*CommunityGalleryIdentifier `json:"identifier,omitempty"`
}
func (cgiv CommunityGalleryImageVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommunityGalleryImageVersion.
func (cgiv *CommunityGalleryImageVersion) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CommunityGalleryImageVersion struct.
CommunityGalleryImageVersionProperties describes the properties of a gallery image version.
type CommunityGalleryImageVersionProperties struct {
// PublishedDate - The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
PublishedDate *date.Time `json:"publishedDate,omitempty"`
// EndOfLifeDate - The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
}
CommunityGalleryImageVersionsClient is the compute Client
type CommunityGalleryImageVersionsClient struct {
BaseClient
}
func NewCommunityGalleryImageVersionsClient(subscriptionID string) CommunityGalleryImageVersionsClient
NewCommunityGalleryImageVersionsClient creates an instance of the CommunityGalleryImageVersionsClient client.
func NewCommunityGalleryImageVersionsClientWithBaseURI(baseURI string, subscriptionID string) CommunityGalleryImageVersionsClient
NewCommunityGalleryImageVersionsClientWithBaseURI creates an instance of the CommunityGalleryImageVersionsClient 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 CommunityGalleryImageVersionsClient) Get(ctx context.Context, location string, publicGalleryName string, galleryImageName string, galleryImageVersionName string) (result CommunityGalleryImageVersion, err error)
Get get a community gallery image version. Parameters: location - resource location. publicGalleryName - the public name of the community gallery. galleryImageName - the name of the community gallery image definition. galleryImageVersionName - the name of the community gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>
func (client CommunityGalleryImageVersionsClient) GetPreparer(ctx context.Context, location string, publicGalleryName string, galleryImageName string, galleryImageVersionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CommunityGalleryImageVersionsClient) GetResponder(resp *http.Response) (result CommunityGalleryImageVersion, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CommunityGalleryImageVersionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
CommunityGalleryImagesClient is the compute Client
type CommunityGalleryImagesClient struct {
BaseClient
}
func NewCommunityGalleryImagesClient(subscriptionID string) CommunityGalleryImagesClient
NewCommunityGalleryImagesClient creates an instance of the CommunityGalleryImagesClient client.
func NewCommunityGalleryImagesClientWithBaseURI(baseURI string, subscriptionID string) CommunityGalleryImagesClient
NewCommunityGalleryImagesClientWithBaseURI creates an instance of the CommunityGalleryImagesClient 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 CommunityGalleryImagesClient) Get(ctx context.Context, location string, publicGalleryName string, galleryImageName string) (result CommunityGalleryImage, err error)
Get get a community gallery image. Parameters: location - resource location. publicGalleryName - the public name of the community gallery. galleryImageName - the name of the community gallery image definition.
func (client CommunityGalleryImagesClient) GetPreparer(ctx context.Context, location string, publicGalleryName string, galleryImageName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CommunityGalleryImagesClient) GetResponder(resp *http.Response) (result CommunityGalleryImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CommunityGalleryImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
CommunityGalleryInfo information of community gallery if current gallery is shared to community
type CommunityGalleryInfo struct {
// PublisherURI - Community gallery publisher uri
PublisherURI *string `json:"publisherUri,omitempty"`
// PublisherContact - Community gallery publisher contact email
PublisherContact *string `json:"publisherContact,omitempty"`
// Eula - Community gallery publisher eula
Eula *string `json:"eula,omitempty"`
// PublicNamePrefix - Community gallery public name prefix
PublicNamePrefix *string `json:"publicNamePrefix,omitempty"`
// CommunityGalleryEnabled - READ-ONLY; Contains info about whether community gallery sharing is enabled.
CommunityGalleryEnabled *bool `json:"communityGalleryEnabled,omitempty"`
// PublicNames - READ-ONLY; Community gallery public name list.
PublicNames *[]string `json:"publicNames,omitempty"`
}
func (cgiVar CommunityGalleryInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommunityGalleryInfo.
ComponentNames enumerates the values for component names.
type ComponentNames string
const (
// ComponentNamesMicrosoftWindowsShellSetup ...
ComponentNamesMicrosoftWindowsShellSetup ComponentNames = "Microsoft-Windows-Shell-Setup"
)
func PossibleComponentNamesValues() []ComponentNames
PossibleComponentNamesValues returns an array of possible values for the ComponentNames const type.
ConfidentialVMEncryptionType enumerates the values for confidential vm encryption type.
type ConfidentialVMEncryptionType string
const (
// ConfidentialVMEncryptionTypeEncryptedVMGuestStateOnlyWithPmk ...
ConfidentialVMEncryptionTypeEncryptedVMGuestStateOnlyWithPmk ConfidentialVMEncryptionType = "EncryptedVMGuestStateOnlyWithPmk"
// ConfidentialVMEncryptionTypeEncryptedWithCmk ...
ConfidentialVMEncryptionTypeEncryptedWithCmk ConfidentialVMEncryptionType = "EncryptedWithCmk"
// ConfidentialVMEncryptionTypeEncryptedWithPmk ...
ConfidentialVMEncryptionTypeEncryptedWithPmk ConfidentialVMEncryptionType = "EncryptedWithPmk"
)
func PossibleConfidentialVMEncryptionTypeValues() []ConfidentialVMEncryptionType
PossibleConfidentialVMEncryptionTypeValues returns an array of possible values for the ConfidentialVMEncryptionType const type.
ConsistencyModeTypes enumerates the values for consistency mode types.
type ConsistencyModeTypes string
const (
// ConsistencyModeTypesApplicationConsistent ...
ConsistencyModeTypesApplicationConsistent ConsistencyModeTypes = "ApplicationConsistent"
// ConsistencyModeTypesCrashConsistent ...
ConsistencyModeTypesCrashConsistent ConsistencyModeTypes = "CrashConsistent"
// ConsistencyModeTypesFileSystemConsistent ...
ConsistencyModeTypesFileSystemConsistent ConsistencyModeTypes = "FileSystemConsistent"
)
func PossibleConsistencyModeTypesValues() []ConsistencyModeTypes
PossibleConsistencyModeTypesValues returns an array of possible values for the ConsistencyModeTypes const type.
CreationData data used when creating a disk.
type CreationData struct {
// CreateOption - This enumerates the possible sources of a disk's creation. Possible values include: 'DiskCreateOptionEmpty', 'DiskCreateOptionAttach', 'DiskCreateOptionFromImage', 'DiskCreateOptionImport', 'DiskCreateOptionCopy', 'DiskCreateOptionRestore', 'DiskCreateOptionUpload', 'DiskCreateOptionCopyStart', 'DiskCreateOptionImportSecure', 'DiskCreateOptionUploadPreparedSecure'
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"`
// LogicalSectorSize - Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
LogicalSectorSize *int32 `json:"logicalSectorSize,omitempty"`
// SecurityDataURI - If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
SecurityDataURI *string `json:"securityDataUri,omitempty"`
}
func (cd CreationData) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreationData.
DataAccessAuthMode enumerates the values for data access auth mode.
type DataAccessAuthMode string
const (
// DataAccessAuthModeAzureActiveDirectory When export/upload URL is used, the system checks if the user has
// an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please
// refer to aka.ms/DisksAzureADAuth.
DataAccessAuthModeAzureActiveDirectory DataAccessAuthMode = "AzureActiveDirectory"
// DataAccessAuthModeNone No additional authentication would be performed when accessing export/upload URL.
DataAccessAuthModeNone DataAccessAuthMode = "None"
)
func PossibleDataAccessAuthModeValues() []DataAccessAuthMode
PossibleDataAccessAuthModeValues returns an array of possible values for the DataAccessAuthMode const type.
DataDisk describes a data disk.
type DataDisk struct {
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Vhd - The virtual hard disk.
Vhd *VirtualHardDisk `json:"vhd,omitempty"`
// Image - The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// 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"`
// DetachOption - Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**. <br><br> detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. Possible values include: 'DiskDetachOptionTypesForceDetach'
DetachOption DiskDetachOptionTypes `json:"detachOption,omitempty"`
// DeleteOption - Specifies whether data disk should be deleted or detached upon VM deletion.<br><br> Possible values: <br><br> **Delete** If this value is used, the data disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the data disk is retained after VM is deleted.<br><br> The default value is set to **detach**. Possible values include: 'DiskDeleteOptionTypesDelete', 'DiskDeleteOptionTypesDetach'
DeleteOption DiskDeleteOptionTypes `json:"deleteOption,omitempty"`
}
func (dd DataDisk) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataDisk.
DataDiskImage contains the data disk images information.
type DataDiskImage struct {
// Lun - READ-ONLY; Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
}
func (ddi DataDiskImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataDiskImage.
DataDiskImageEncryption contains encryption settings for a data disk image.
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"`
}
DedicatedHost specifies information about the Dedicated host.
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"`
}
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.
DedicatedHostAllocatableVM represents the dedicated host unutilized capacity in terms of a specific VM size.
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"`
}
DedicatedHostAvailableCapacity dedicated host unutilized capacity.
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"`
}
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.
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"`
}
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.
DedicatedHostGroupInstanceView ...
type DedicatedHostGroupInstanceView struct {
// Hosts - List of instance view of the dedicated hosts under the dedicated host group.
Hosts *[]DedicatedHostInstanceViewWithName `json:"hosts,omitempty"`
}
DedicatedHostGroupListResult the List Dedicated Host Group with resource group response.
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"`
}
func (dhglr DedicatedHostGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DedicatedHostGroupListResultIterator provides access to a complete listing of DedicatedHostGroup values.
type DedicatedHostGroupListResultIterator struct {
// contains filtered or unexported fields
}
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.
DedicatedHostGroupListResultPage contains a page of DedicatedHostGroup values.
type DedicatedHostGroupListResultPage struct {
// contains filtered or unexported fields
}
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.
DedicatedHostGroupProperties dedicated Host Group Properties.
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"`
// InstanceView - READ-ONLY; The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
InstanceView *DedicatedHostGroupInstanceView `json:"instanceView,omitempty"`
// SupportAutomaticPlacement - Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. <br><br>Minimum api-version: 2020-06-01.
SupportAutomaticPlacement *bool `json:"supportAutomaticPlacement,omitempty"`
}
func (dhgp DedicatedHostGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostGroupProperties.
DedicatedHostGroupUpdate specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.
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"`
}
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.
DedicatedHostGroupsClient is the compute Client
type DedicatedHostGroupsClient struct {
BaseClient
}
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.
func (client DedicatedHostGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHostGroupsClient) Get(ctx context.Context, resourceGroupName string, hostGroupName string, expand InstanceViewTypes) (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. expand - the expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.
func (client DedicatedHostGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, hostGroupName string, expand InstanceViewTypes) (*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.
func (client DedicatedHostGroupsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client 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.
func (client DedicatedHostGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DedicatedHostInstanceView the instance view of a dedicated host.
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"`
}
func (dhiv DedicatedHostInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostInstanceView.
DedicatedHostInstanceViewWithName the instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.
type DedicatedHostInstanceViewWithName struct {
// Name - READ-ONLY; The name of the dedicated host.
Name *string `json:"name,omitempty"`
// 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"`
}
func (dhivwn DedicatedHostInstanceViewWithName) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostInstanceViewWithName.
DedicatedHostLicenseTypes enumerates the values for dedicated host license types.
type DedicatedHostLicenseTypes string
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.
DedicatedHostListResult the list dedicated host operation response.
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"`
}
func (dhlr DedicatedHostListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DedicatedHostListResultIterator provides access to a complete listing of DedicatedHost values.
type DedicatedHostListResultIterator struct {
// contains filtered or unexported fields
}
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.
DedicatedHostListResultPage contains a page of DedicatedHost values.
type DedicatedHostListResultPage struct {
// contains filtered or unexported fields
}
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.
DedicatedHostProperties properties of the dedicated host.
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"`
// TimeCreated - READ-ONLY; Specifies the time at which the Dedicated Host resource was created.<br><br>Minimum api-version: 2021-11-01.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
}
func (dhp DedicatedHostProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHostProperties.
DedicatedHostUpdate specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
type DedicatedHostUpdate struct {
*DedicatedHostProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
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.
DedicatedHostsClient is the compute Client
type DedicatedHostsClient struct {
BaseClient
}
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. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.
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.
func (client DedicatedHostsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client 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) Restart(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string) (result DedicatedHostsRestartFuture, err error)
Restart restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/en-us/azure/service-health/resource-health-overview for more details. 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) RestartPreparer(ctx context.Context, resourceGroupName string, hostGroupName string, hostName string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client DedicatedHostsClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client DedicatedHostsClient) RestartSender(req *http.Request) (future DedicatedHostsRestartFuture, err error)
RestartSender sends the Restart 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.
DedicatedHostsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *DedicatedHostsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DedicatedHostsDeleteFuture 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)
}
func (future *DedicatedHostsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DedicatedHostsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DedicatedHostsRestartFuture 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)
}
func (future *DedicatedHostsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DedicatedHostsUpdateFuture 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)
}
func (future *DedicatedHostsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DeleteOptions enumerates the values for delete options.
type DeleteOptions string
const (
// DeleteOptionsDelete ...
DeleteOptionsDelete DeleteOptions = "Delete"
// DeleteOptionsDetach ...
DeleteOptionsDetach DeleteOptions = "Detach"
)
func PossibleDeleteOptionsValues() []DeleteOptions
PossibleDeleteOptionsValues returns an array of possible values for the DeleteOptions const type.
DiagnosticsProfile specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
type DiagnosticsProfile struct {
// BootDiagnostics - Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br>**NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. <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"`
}
DiffDiskOptions enumerates the values for diff disk options.
type DiffDiskOptions string
const (
// DiffDiskOptionsLocal ...
DiffDiskOptionsLocal 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.
type DiffDiskPlacement string
const (
// DiffDiskPlacementCacheDisk ...
DiffDiskPlacementCacheDisk DiffDiskPlacement = "CacheDisk"
// DiffDiskPlacementResourceDisk ...
DiffDiskPlacementResourceDisk DiffDiskPlacement = "ResourceDisk"
)
func PossibleDiffDiskPlacementValues() []DiffDiskPlacement
PossibleDiffDiskPlacementValues returns an array of possible values for the DiffDiskPlacement const type.
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 DiffDiskSettings struct {
// Option - Specifies the ephemeral disk settings for operating system disk. Possible values include: 'DiffDiskOptionsLocal'
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/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'DiffDiskPlacementCacheDisk', 'DiffDiskPlacementResourceDisk'
Placement DiffDiskPlacement `json:"placement,omitempty"`
}
Disallowed describes the disallowed disk types.
type Disallowed struct {
// DiskTypes - A list of disk types.
DiskTypes *[]string `json:"diskTypes,omitempty"`
}
DisallowedConfiguration specifies the disallowed configuration for a virtual machine image.
type DisallowedConfiguration struct {
// VMDiskType - VM disk types which are disallowed. Possible values include: 'VMDiskTypesNone', 'VMDiskTypesUnmanaged'
VMDiskType VMDiskTypes `json:"vmDiskType,omitempty"`
}
Disk disk resource.
type Disk struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; A relative URI containing the ID of the VM that has the disk attached.
ManagedBy *string `json:"managedBy,omitempty"`
// 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"`
// ExtendedLocation - The extended location where the disk will be created. Extended location cannot be changed.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
*DiskProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (d Disk) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Disk.
func (d *Disk) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Disk struct.
DiskAccess disk access resource.
type DiskAccess struct {
autorest.Response `json:"-"`
*DiskAccessProperties `json:"properties,omitempty"`
// ExtendedLocation - The extended location where the disk access will be created. Extended location cannot be changed.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (da DiskAccess) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskAccess.
func (da *DiskAccess) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskAccess struct.
DiskAccessList the List disk access operation response.
type DiskAccessList struct {
autorest.Response `json:"-"`
// Value - A list of disk access resources.
Value *[]DiskAccess `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources.
NextLink *string `json:"nextLink,omitempty"`
}
func (dal DiskAccessList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskAccessListIterator provides access to a complete listing of DiskAccess values.
type DiskAccessListIterator struct {
// contains filtered or unexported fields
}
func NewDiskAccessListIterator(page DiskAccessListPage) DiskAccessListIterator
Creates a new instance of the DiskAccessListIterator type.
func (iter *DiskAccessListIterator) 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 *DiskAccessListIterator) 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 DiskAccessListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskAccessListIterator) Response() DiskAccessList
Response returns the raw server response from the last page request.
func (iter DiskAccessListIterator) Value() DiskAccess
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DiskAccessListPage contains a page of DiskAccess values.
type DiskAccessListPage struct {
// contains filtered or unexported fields
}
func NewDiskAccessListPage(cur DiskAccessList, getNextPage func(context.Context, DiskAccessList) (DiskAccessList, error)) DiskAccessListPage
Creates a new instance of the DiskAccessListPage type.
func (page *DiskAccessListPage) 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 *DiskAccessListPage) 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 DiskAccessListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskAccessListPage) Response() DiskAccessList
Response returns the raw server response from the last page request.
func (page DiskAccessListPage) Values() []DiskAccess
Values returns the slice of values for the current page or nil if there are no values.
DiskAccessProperties ...
type DiskAccessProperties struct {
// PrivateEndpointConnections - READ-ONLY; A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
// ProvisioningState - READ-ONLY; The disk access resource provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// TimeCreated - READ-ONLY; The time when the disk access was created.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
}
func (dap DiskAccessProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskAccessProperties.
DiskAccessUpdate used for updating a disk access resource.
type DiskAccessUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (dau DiskAccessUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskAccessUpdate.
DiskAccessesClient is the compute Client
type DiskAccessesClient struct {
BaseClient
}
func NewDiskAccessesClient(subscriptionID string) DiskAccessesClient
NewDiskAccessesClient creates an instance of the DiskAccessesClient client.
func NewDiskAccessesClientWithBaseURI(baseURI string, subscriptionID string) DiskAccessesClient
NewDiskAccessesClientWithBaseURI creates an instance of the DiskAccessesClient 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 DiskAccessesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskAccessName string, diskAccess DiskAccess) (result DiskAccessesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a disk access resource Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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. diskAccess - disk access object supplied in the body of the Put disk access operation.
func (client DiskAccessesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskAccessName string, diskAccess DiskAccess) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DiskAccessesClient) CreateOrUpdateResponder(resp *http.Response) (result DiskAccess, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DiskAccessesClient) CreateOrUpdateSender(req *http.Request) (future DiskAccessesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) Delete(ctx context.Context, resourceGroupName string, diskAccessName string) (result DiskAccessesDeleteFuture, err error)
Delete deletes a disk access resource. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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 DiskAccessesClient) DeleteAPrivateEndpointConnection(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string) (result DiskAccessesDeleteAPrivateEndpointConnectionFuture, err error)
DeleteAPrivateEndpointConnection deletes a private endpoint connection under a disk access resource. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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. privateEndpointConnectionName - the name of the private endpoint connection.
func (client DiskAccessesClient) DeleteAPrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string) (*http.Request, error)
DeleteAPrivateEndpointConnectionPreparer prepares the DeleteAPrivateEndpointConnection request.
func (client DiskAccessesClient) DeleteAPrivateEndpointConnectionResponder(resp *http.Response) (result autorest.Response, err error)
DeleteAPrivateEndpointConnectionResponder handles the response to the DeleteAPrivateEndpointConnection request. The method always closes the http.Response Body.
func (client DiskAccessesClient) DeleteAPrivateEndpointConnectionSender(req *http.Request) (future DiskAccessesDeleteAPrivateEndpointConnectionFuture, err error)
DeleteAPrivateEndpointConnectionSender sends the DeleteAPrivateEndpointConnection request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskAccessName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DiskAccessesClient) 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 DiskAccessesClient) DeleteSender(req *http.Request) (future DiskAccessesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) Get(ctx context.Context, resourceGroupName string, diskAccessName string) (result DiskAccess, err error)
Get gets information about a disk access resource. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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 DiskAccessesClient) GetAPrivateEndpointConnection(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)
GetAPrivateEndpointConnection gets information about a private endpoint connection under a disk access resource. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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. privateEndpointConnectionName - the name of the private endpoint connection.
func (client DiskAccessesClient) GetAPrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string) (*http.Request, error)
GetAPrivateEndpointConnectionPreparer prepares the GetAPrivateEndpointConnection request.
func (client DiskAccessesClient) GetAPrivateEndpointConnectionResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
GetAPrivateEndpointConnectionResponder handles the response to the GetAPrivateEndpointConnection request. The method always closes the http.Response Body.
func (client DiskAccessesClient) GetAPrivateEndpointConnectionSender(req *http.Request) (*http.Response, error)
GetAPrivateEndpointConnectionSender sends the GetAPrivateEndpointConnection request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) GetPreparer(ctx context.Context, resourceGroupName string, diskAccessName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DiskAccessesClient) GetPrivateLinkResources(ctx context.Context, resourceGroupName string, diskAccessName string) (result PrivateLinkResourceListResult, err error)
GetPrivateLinkResources gets the private link resources possible under disk access resource Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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 DiskAccessesClient) GetPrivateLinkResourcesPreparer(ctx context.Context, resourceGroupName string, diskAccessName string) (*http.Request, error)
GetPrivateLinkResourcesPreparer prepares the GetPrivateLinkResources request.
func (client DiskAccessesClient) GetPrivateLinkResourcesResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)
GetPrivateLinkResourcesResponder handles the response to the GetPrivateLinkResources request. The method always closes the http.Response Body.
func (client DiskAccessesClient) GetPrivateLinkResourcesSender(req *http.Request) (*http.Response, error)
GetPrivateLinkResourcesSender sends the GetPrivateLinkResources request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) GetResponder(resp *http.Response) (result DiskAccess, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DiskAccessesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) List(ctx context.Context) (result DiskAccessListPage, err error)
List lists all the disk access resources under a subscription.
func (client DiskAccessesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskAccessListPage, err error)
ListByResourceGroup lists all the disk access resources under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client DiskAccessesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskAccessListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskAccessesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DiskAccessesClient) ListByResourceGroupResponder(resp *http.Response) (result DiskAccessList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DiskAccessesClient) 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 DiskAccessesClient) ListComplete(ctx context.Context) (result DiskAccessListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskAccessesClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client DiskAccessesClient) ListPrivateEndpointConnections(ctx context.Context, resourceGroupName string, diskAccessName string) (result PrivateEndpointConnectionListResultPage, err error)
ListPrivateEndpointConnections list information about private endpoint connections under a disk access resource Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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 DiskAccessesClient) ListPrivateEndpointConnectionsComplete(ctx context.Context, resourceGroupName string, diskAccessName string) (result PrivateEndpointConnectionListResultIterator, err error)
ListPrivateEndpointConnectionsComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskAccessesClient) ListPrivateEndpointConnectionsPreparer(ctx context.Context, resourceGroupName string, diskAccessName string) (*http.Request, error)
ListPrivateEndpointConnectionsPreparer prepares the ListPrivateEndpointConnections request.
func (client DiskAccessesClient) ListPrivateEndpointConnectionsResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)
ListPrivateEndpointConnectionsResponder handles the response to the ListPrivateEndpointConnections request. The method always closes the http.Response Body.
func (client DiskAccessesClient) ListPrivateEndpointConnectionsSender(req *http.Request) (*http.Response, error)
ListPrivateEndpointConnectionsSender sends the ListPrivateEndpointConnections request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) ListResponder(resp *http.Response) (result DiskAccessList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DiskAccessesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) Update(ctx context.Context, resourceGroupName string, diskAccessName string, diskAccess DiskAccessUpdate) (result DiskAccessesUpdateFuture, err error)
Update updates (patches) a disk access resource. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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. diskAccess - disk access object supplied in the body of the Patch disk access operation.
func (client DiskAccessesClient) UpdateAPrivateEndpointConnection(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (result DiskAccessesUpdateAPrivateEndpointConnectionFuture, err error)
UpdateAPrivateEndpointConnection approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection. Parameters: resourceGroupName - the name of the resource group. diskAccessName - the name of the disk access resource 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. privateEndpointConnectionName - the name of the private endpoint connection. privateEndpointConnection - private endpoint connection object supplied in the body of the Put private endpoint connection operation.
func (client DiskAccessesClient) UpdateAPrivateEndpointConnectionPreparer(ctx context.Context, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (*http.Request, error)
UpdateAPrivateEndpointConnectionPreparer prepares the UpdateAPrivateEndpointConnection request.
func (client DiskAccessesClient) UpdateAPrivateEndpointConnectionResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
UpdateAPrivateEndpointConnectionResponder handles the response to the UpdateAPrivateEndpointConnection request. The method always closes the http.Response Body.
func (client DiskAccessesClient) UpdateAPrivateEndpointConnectionSender(req *http.Request) (future DiskAccessesUpdateAPrivateEndpointConnectionFuture, err error)
UpdateAPrivateEndpointConnectionSender sends the UpdateAPrivateEndpointConnection request. The method will close the http.Response Body if it receives an error.
func (client DiskAccessesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, diskAccessName string, diskAccess DiskAccessUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DiskAccessesClient) UpdateResponder(resp *http.Response) (result DiskAccess, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DiskAccessesClient) UpdateSender(req *http.Request) (future DiskAccessesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DiskAccessesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskAccessesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskAccessesClient) (DiskAccess, error)
}
func (future *DiskAccessesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskAccessesDeleteAPrivateEndpointConnectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskAccessesDeleteAPrivateEndpointConnectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskAccessesClient) (autorest.Response, error)
}
func (future *DiskAccessesDeleteAPrivateEndpointConnectionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskAccessesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskAccessesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskAccessesClient) (autorest.Response, error)
}
func (future *DiskAccessesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskAccessesUpdateAPrivateEndpointConnectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskAccessesUpdateAPrivateEndpointConnectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskAccessesClient) (PrivateEndpointConnection, error)
}
func (future *DiskAccessesUpdateAPrivateEndpointConnectionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskAccessesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskAccessesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskAccessesClient) (DiskAccess, error)
}
func (future *DiskAccessesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskCreateOption enumerates the values for disk create option.
type DiskCreateOption string
const (
// DiskCreateOptionAttach Disk will be attached to a VM.
DiskCreateOptionAttach DiskCreateOption = "Attach"
// DiskCreateOptionCopy Create a new disk or snapshot by copying from a disk or snapshot specified by the
// given sourceResourceId.
DiskCreateOptionCopy DiskCreateOption = "Copy"
// DiskCreateOptionCopyStart Create a new disk by using a deep copy process, where the resource creation is
// considered complete only after all data has been copied from the source.
DiskCreateOptionCopyStart DiskCreateOption = "CopyStart"
// DiskCreateOptionEmpty Create an empty data disk of a size given by diskSizeGB.
DiskCreateOptionEmpty DiskCreateOption = "Empty"
// DiskCreateOptionFromImage Create a new disk from a platform image specified by the given imageReference
// or galleryImageReference.
DiskCreateOptionFromImage DiskCreateOption = "FromImage"
// DiskCreateOptionImport Create a disk by importing from a blob specified by a sourceUri in a storage
// account specified by storageAccountId.
DiskCreateOptionImport DiskCreateOption = "Import"
// DiskCreateOptionImportSecure Similar to Import create option. Create a new Trusted Launch VM or
// Confidential VM supported disk by importing additional blob for VM guest state specified by
// securityDataUri in storage account specified by storageAccountId
DiskCreateOptionImportSecure DiskCreateOption = "ImportSecure"
// DiskCreateOptionRestore Create a new disk by copying from a backup recovery point.
DiskCreateOptionRestore DiskCreateOption = "Restore"
// DiskCreateOptionUpload Create a new disk by obtaining a write token and using it to directly upload the
// contents of the disk.
DiskCreateOptionUpload DiskCreateOption = "Upload"
// DiskCreateOptionUploadPreparedSecure Similar to Upload create option. Create a new Trusted Launch VM or
// Confidential VM supported disk and upload using write token in both disk and VM guest state
DiskCreateOptionUploadPreparedSecure DiskCreateOption = "UploadPreparedSecure"
)
func PossibleDiskCreateOptionValues() []DiskCreateOption
PossibleDiskCreateOptionValues returns an array of possible values for the DiskCreateOption const type.
DiskCreateOptionTypes enumerates the values for disk create option types.
type DiskCreateOptionTypes string
const (
// DiskCreateOptionTypesAttach ...
DiskCreateOptionTypesAttach DiskCreateOptionTypes = "Attach"
// DiskCreateOptionTypesEmpty ...
DiskCreateOptionTypesEmpty DiskCreateOptionTypes = "Empty"
// DiskCreateOptionTypesFromImage ...
DiskCreateOptionTypesFromImage DiskCreateOptionTypes = "FromImage"
)
func PossibleDiskCreateOptionTypesValues() []DiskCreateOptionTypes
PossibleDiskCreateOptionTypesValues returns an array of possible values for the DiskCreateOptionTypes const type.
DiskDeleteOptionTypes enumerates the values for disk delete option types.
type DiskDeleteOptionTypes string
const (
// DiskDeleteOptionTypesDelete ...
DiskDeleteOptionTypesDelete DiskDeleteOptionTypes = "Delete"
// DiskDeleteOptionTypesDetach ...
DiskDeleteOptionTypesDetach DiskDeleteOptionTypes = "Detach"
)
func PossibleDiskDeleteOptionTypesValues() []DiskDeleteOptionTypes
PossibleDiskDeleteOptionTypesValues returns an array of possible values for the DiskDeleteOptionTypes const type.
DiskDetachOptionTypes enumerates the values for disk detach option types.
type DiskDetachOptionTypes string
const (
// DiskDetachOptionTypesForceDetach ...
DiskDetachOptionTypesForceDetach DiskDetachOptionTypes = "ForceDetach"
)
func PossibleDiskDetachOptionTypesValues() []DiskDetachOptionTypes
PossibleDiskDetachOptionTypesValues returns an array of possible values for the DiskDetachOptionTypes const type.
DiskEncryptionSet disk encryption set resource.
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"`
}
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.
type DiskEncryptionSetIdentityType string
const (
// DiskEncryptionSetIdentityTypeNone ...
DiskEncryptionSetIdentityTypeNone DiskEncryptionSetIdentityType = "None"
// DiskEncryptionSetIdentityTypeSystemAssigned ...
DiskEncryptionSetIdentityTypeSystemAssigned DiskEncryptionSetIdentityType = "SystemAssigned"
)
func PossibleDiskEncryptionSetIdentityTypeValues() []DiskEncryptionSetIdentityType
PossibleDiskEncryptionSetIdentityTypeValues returns an array of possible values for the DiskEncryptionSetIdentityType const type.
DiskEncryptionSetList the List disk encryption set operation response.
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"`
}
func (desl DiskEncryptionSetList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskEncryptionSetListIterator provides access to a complete listing of DiskEncryptionSet values.
type DiskEncryptionSetListIterator struct {
// contains filtered or unexported fields
}
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.
DiskEncryptionSetListPage contains a page of DiskEncryptionSet values.
type DiskEncryptionSetListPage struct {
// contains filtered or unexported fields
}
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 DiskEncryptionSetParameters struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
DiskEncryptionSetType enumerates the values for disk encryption set type.
type DiskEncryptionSetType string
const (
// DiskEncryptionSetTypeConfidentialVMEncryptedWithCustomerKey Confidential VM supported disk and VM guest
// state would be encrypted with customer managed key.
DiskEncryptionSetTypeConfidentialVMEncryptedWithCustomerKey DiskEncryptionSetType = "ConfidentialVmEncryptedWithCustomerKey"
// DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey Resource using diskEncryptionSet would be encrypted
// at rest with Customer managed key that can be changed and revoked by a customer.
DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey DiskEncryptionSetType = "EncryptionAtRestWithCustomerKey"
// DiskEncryptionSetTypeEncryptionAtRestWithPlatformAndCustomerKeys Resource using diskEncryptionSet would
// be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other
// key is Platform managed.
DiskEncryptionSetTypeEncryptionAtRestWithPlatformAndCustomerKeys DiskEncryptionSetType = "EncryptionAtRestWithPlatformAndCustomerKeys"
)
func PossibleDiskEncryptionSetTypeValues() []DiskEncryptionSetType
PossibleDiskEncryptionSetTypeValues returns an array of possible values for the DiskEncryptionSetType const type.
DiskEncryptionSetUpdate disk encryption set update resource.
type DiskEncryptionSetUpdate struct {
*DiskEncryptionSetUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Identity *EncryptionSetIdentity `json:"identity,omitempty"`
}
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.
DiskEncryptionSetUpdateProperties disk encryption set resource update properties.
type DiskEncryptionSetUpdateProperties struct {
// EncryptionType - Possible values include: 'DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey', 'DiskEncryptionSetTypeEncryptionAtRestWithPlatformAndCustomerKeys', 'DiskEncryptionSetTypeConfidentialVMEncryptedWithCustomerKey'
EncryptionType DiskEncryptionSetType `json:"encryptionType,omitempty"`
ActiveKey *KeyForDiskEncryptionSet `json:"activeKey,omitempty"`
// RotationToLatestKeyVersionEnabled - Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
RotationToLatestKeyVersionEnabled *bool `json:"rotationToLatestKeyVersionEnabled,omitempty"`
}
DiskEncryptionSetsClient is the compute Client
type DiskEncryptionSetsClient struct {
BaseClient
}
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.
func (client DiskEncryptionSetsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DiskEncryptionSetsClient) List(ctx context.Context) (result DiskEncryptionSetListPage, err error)
List lists all the disk encryption sets under a subscription.
func (client DiskEncryptionSetsClient) ListAssociatedResources(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (result ResourceURIListPage, err error)
ListAssociatedResources lists all resources that are encrypted with this 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) ListAssociatedResourcesComplete(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (result ResourceURIListIterator, err error)
ListAssociatedResourcesComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskEncryptionSetsClient) ListAssociatedResourcesPreparer(ctx context.Context, resourceGroupName string, diskEncryptionSetName string) (*http.Request, error)
ListAssociatedResourcesPreparer prepares the ListAssociatedResources request.
func (client DiskEncryptionSetsClient) ListAssociatedResourcesResponder(resp *http.Response) (result ResourceURIList, err error)
ListAssociatedResourcesResponder handles the response to the ListAssociatedResources request. The method always closes the http.Response Body.
func (client DiskEncryptionSetsClient) ListAssociatedResourcesSender(req *http.Request) (*http.Response, error)
ListAssociatedResourcesSender sends the ListAssociatedResources request. The method will close the http.Response Body if it receives an error.
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.
func (client DiskEncryptionSetsClient) ListPreparer(ctx context.Context) (*http.Request, error)
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.
func (client DiskEncryptionSetsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client 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.
DiskEncryptionSetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *DiskEncryptionSetsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskEncryptionSetsDeleteFuture 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)
}
func (future *DiskEncryptionSetsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskEncryptionSetsUpdateFuture 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)
}
func (future *DiskEncryptionSetsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskEncryptionSettings describes a Encryption Settings for a Disk
type DiskEncryptionSettings struct {
// DiskEncryptionKey - Specifies the location of the disk encryption key, which is a Key Vault Secret.
DiskEncryptionKey *KeyVaultSecretReference `json:"diskEncryptionKey,omitempty"`
// KeyEncryptionKey - Specifies the location of the key encryption key in Key Vault.
KeyEncryptionKey *KeyVaultKeyReference `json:"keyEncryptionKey,omitempty"`
// Enabled - Specifies whether disk encryption should be enabled on the virtual machine.
Enabled *bool `json:"enabled,omitempty"`
}
DiskImageEncryption this is the disk image encryption base class.
type DiskImageEncryption struct {
// DiskEncryptionSetID - A relative URI containing the resource ID of the disk encryption set.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
}
DiskInstanceView the instance view of the disk.
type DiskInstanceView struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// EncryptionSettings - Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
EncryptionSettings *[]DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
DiskList the List Disks operation response.
type DiskList struct {
autorest.Response `json:"-"`
// Value - A list of disks.
Value *[]Disk `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks.
NextLink *string `json:"nextLink,omitempty"`
}
func (dl DiskList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskListIterator provides access to a complete listing of Disk values.
type DiskListIterator struct {
// contains filtered or unexported fields
}
func NewDiskListIterator(page DiskListPage) DiskListIterator
Creates a new instance of the DiskListIterator type.
func (iter *DiskListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DiskListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DiskListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskListIterator) Response() DiskList
Response returns the raw server response from the last page request.
func (iter DiskListIterator) Value() Disk
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DiskListPage contains a page of Disk values.
type DiskListPage struct {
// contains filtered or unexported fields
}
func NewDiskListPage(cur DiskList, getNextPage func(context.Context, DiskList) (DiskList, error)) DiskListPage
Creates a new instance of the DiskListPage type.
func (page *DiskListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DiskListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DiskListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskListPage) Response() DiskList
Response returns the raw server response from the last page request.
func (page DiskListPage) Values() []Disk
Values returns the slice of values for the current page or nil if there are no values.
DiskProperties disk resource properties.
type DiskProperties struct {
// TimeCreated - READ-ONLY; The time when the disk was created.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// OsType - The Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// PurchasePlan - Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
PurchasePlan *PurchasePlan `json:"purchasePlan,omitempty"`
// SupportedCapabilities - List of supported capabilities for the image from which the OS disk was created.
SupportedCapabilities *SupportedCapabilities `json:"supportedCapabilities,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 - The state of the disk. Possible values include: 'DiskStateUnattached', 'DiskStateAttached', 'DiskStateReserved', 'DiskStateFrozen', 'DiskStateActiveSAS', 'DiskStateActiveSASFrozen', 'DiskStateReadyToUpload', 'DiskStateActiveUpload'
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.
MaxShares *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.
ShareInfo *[]ShareInfoElement `json:"shareInfo,omitempty"`
// NetworkAccessPolicy - Possible values include: 'NetworkAccessPolicyAllowAll', 'NetworkAccessPolicyAllowPrivate', 'NetworkAccessPolicyDenyAll'
NetworkAccessPolicy NetworkAccessPolicy `json:"networkAccessPolicy,omitempty"`
// DiskAccessID - ARM id of the DiskAccess resource for using private endpoints on disks.
DiskAccessID *string `json:"diskAccessId,omitempty"`
// Tier - Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
Tier *string `json:"tier,omitempty"`
// BurstingEnabled - Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
BurstingEnabled *bool `json:"burstingEnabled,omitempty"`
// PropertyUpdatesInProgress - READ-ONLY; Properties of the disk for which update is pending.
PropertyUpdatesInProgress *PropertyUpdatesInProgress `json:"propertyUpdatesInProgress,omitempty"`
// SupportsHibernation - Indicates the OS on a disk supports hibernation.
SupportsHibernation *bool `json:"supportsHibernation,omitempty"`
// SecurityProfile - Contains the security related information for the resource.
SecurityProfile *DiskSecurityProfile `json:"securityProfile,omitempty"`
// CompletionPercent - Percentage complete for the background copy when a resource is created via the CopyStart operation.
CompletionPercent *float64 `json:"completionPercent,omitempty"`
// PublicNetworkAccess - Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// DataAccessAuthMode - Possible values include: 'DataAccessAuthModeAzureActiveDirectory', 'DataAccessAuthModeNone'
DataAccessAuthMode DataAccessAuthMode `json:"dataAccessAuthMode,omitempty"`
}
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
DiskRestorePoint properties of disk restore point
type DiskRestorePoint struct {
autorest.Response `json:"-"`
*DiskRestorePointProperties `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"`
}
func (drp DiskRestorePoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskRestorePoint.
func (drp *DiskRestorePoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskRestorePoint struct.
DiskRestorePointClient is the compute Client
type DiskRestorePointClient struct {
BaseClient
}
func NewDiskRestorePointClient(subscriptionID string) DiskRestorePointClient
NewDiskRestorePointClient creates an instance of the DiskRestorePointClient client.
func NewDiskRestorePointClientWithBaseURI(baseURI string, subscriptionID string) DiskRestorePointClient
NewDiskRestorePointClientWithBaseURI creates an instance of the DiskRestorePointClient 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 DiskRestorePointClient) Get(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string) (result DiskRestorePoint, err error)
Get get disk restorePoint resource Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection that the disk restore point belongs. VMRestorePointName - the name of the vm restore point that the disk disk restore point belongs. diskRestorePointName - the name of the disk restore point created.
func (client DiskRestorePointClient) GetPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DiskRestorePointClient) GetResponder(resp *http.Response) (result DiskRestorePoint, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DiskRestorePointClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DiskRestorePointClient) GrantAccess(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string, grantAccessData GrantAccessData) (result DiskRestorePointGrantAccessFuture, err error)
GrantAccess grants access to a diskRestorePoint. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection that the disk restore point belongs. VMRestorePointName - the name of the vm restore point that the disk disk restore point belongs. diskRestorePointName - the name of the disk restore point created. grantAccessData - access data object supplied in the body of the get disk access operation.
func (client DiskRestorePointClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
func (client DiskRestorePointClient) GrantAccessResponder(resp *http.Response) (result AccessURI, err error)
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client DiskRestorePointClient) GrantAccessSender(req *http.Request) (future DiskRestorePointGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client DiskRestorePointClient) ListByRestorePoint(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string) (result DiskRestorePointListPage, err error)
ListByRestorePoint lists diskRestorePoints under a vmRestorePoint. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection that the disk restore point belongs. VMRestorePointName - the name of the vm restore point that the disk disk restore point belongs.
func (client DiskRestorePointClient) ListByRestorePointComplete(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string) (result DiskRestorePointListIterator, err error)
ListByRestorePointComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiskRestorePointClient) ListByRestorePointPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string) (*http.Request, error)
ListByRestorePointPreparer prepares the ListByRestorePoint request.
func (client DiskRestorePointClient) ListByRestorePointResponder(resp *http.Response) (result DiskRestorePointList, err error)
ListByRestorePointResponder handles the response to the ListByRestorePoint request. The method always closes the http.Response Body.
func (client DiskRestorePointClient) ListByRestorePointSender(req *http.Request) (*http.Response, error)
ListByRestorePointSender sends the ListByRestorePoint request. The method will close the http.Response Body if it receives an error.
func (client DiskRestorePointClient) RevokeAccess(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string) (result DiskRestorePointRevokeAccessFuture, err error)
RevokeAccess revokes access to a diskRestorePoint. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection that the disk restore point belongs. VMRestorePointName - the name of the vm restore point that the disk disk restore point belongs. diskRestorePointName - the name of the disk restore point created.
func (client DiskRestorePointClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, VMRestorePointName string, diskRestorePointName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client DiskRestorePointClient) 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 DiskRestorePointClient) RevokeAccessSender(req *http.Request) (future DiskRestorePointRevokeAccessFuture, err error)
RevokeAccessSender sends the RevokeAccess request. The method will close the http.Response Body if it receives an error.
DiskRestorePointGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskRestorePointGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskRestorePointClient) (AccessURI, error)
}
func (future *DiskRestorePointGrantAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskRestorePointInstanceView the instance view of a disk restore point.
type DiskRestorePointInstanceView struct {
// ID - Disk restore point Id.
ID *string `json:"id,omitempty"`
// ReplicationStatus - The disk restore point replication status information.
ReplicationStatus interface{} `json:"replicationStatus,omitempty"`
}
DiskRestorePointList the List Disk Restore Points operation response.
type DiskRestorePointList struct {
autorest.Response `json:"-"`
// Value - A list of disk restore points.
Value *[]DiskRestorePoint `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disk restore points. Call ListNext() with this to fetch the next page of disk restore points.
NextLink *string `json:"nextLink,omitempty"`
}
func (drpl DiskRestorePointList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskRestorePointListIterator provides access to a complete listing of DiskRestorePoint values.
type DiskRestorePointListIterator struct {
// contains filtered or unexported fields
}
func NewDiskRestorePointListIterator(page DiskRestorePointListPage) DiskRestorePointListIterator
Creates a new instance of the DiskRestorePointListIterator type.
func (iter *DiskRestorePointListIterator) 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 *DiskRestorePointListIterator) 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 DiskRestorePointListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskRestorePointListIterator) Response() DiskRestorePointList
Response returns the raw server response from the last page request.
func (iter DiskRestorePointListIterator) Value() DiskRestorePoint
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DiskRestorePointListPage contains a page of DiskRestorePoint values.
type DiskRestorePointListPage struct {
// contains filtered or unexported fields
}
func NewDiskRestorePointListPage(cur DiskRestorePointList, getNextPage func(context.Context, DiskRestorePointList) (DiskRestorePointList, error)) DiskRestorePointListPage
Creates a new instance of the DiskRestorePointListPage type.
func (page *DiskRestorePointListPage) 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 *DiskRestorePointListPage) 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 DiskRestorePointListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskRestorePointListPage) Response() DiskRestorePointList
Response returns the raw server response from the last page request.
func (page DiskRestorePointListPage) Values() []DiskRestorePoint
Values returns the slice of values for the current page or nil if there are no values.
DiskRestorePointProperties properties of an incremental disk restore point
type DiskRestorePointProperties struct {
// TimeCreated - READ-ONLY; The timestamp of restorePoint creation
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// SourceResourceID - READ-ONLY; arm id of source disk or source disk restore point.
SourceResourceID *string `json:"sourceResourceId,omitempty"`
// OsType - READ-ONLY; The Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// PurchasePlan - Purchase plan information for the the image from which the OS disk was created.
PurchasePlan *PurchasePlan `json:"purchasePlan,omitempty"`
// SupportedCapabilities - List of supported capabilities for the image from which the OS disk was created.
SupportedCapabilities *SupportedCapabilities `json:"supportedCapabilities,omitempty"`
// FamilyID - READ-ONLY; id of the backing snapshot's MIS family
FamilyID *string `json:"familyId,omitempty"`
// SourceUniqueID - READ-ONLY; unique incarnation id of the source disk
SourceUniqueID *string `json:"sourceUniqueId,omitempty"`
// Encryption - READ-ONLY; Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Encryption *Encryption `json:"encryption,omitempty"`
// SupportsHibernation - Indicates the OS on a disk supports hibernation.
SupportsHibernation *bool `json:"supportsHibernation,omitempty"`
// NetworkAccessPolicy - Possible values include: 'NetworkAccessPolicyAllowAll', 'NetworkAccessPolicyAllowPrivate', 'NetworkAccessPolicyDenyAll'
NetworkAccessPolicy NetworkAccessPolicy `json:"networkAccessPolicy,omitempty"`
// PublicNetworkAccess - Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// DiskAccessID - ARM id of the DiskAccess resource for using private endpoints on disks.
DiskAccessID *string `json:"diskAccessId,omitempty"`
// CompletionPercent - Percentage complete for the background copy of disk restore point when source resource is from a different region.
CompletionPercent *float64 `json:"completionPercent,omitempty"`
// ReplicationState - READ-ONLY; Replication state of disk restore point when source resource is from a different region.
ReplicationState *string `json:"replicationState,omitempty"`
// SourceResourceLocation - READ-ONLY; Location of source disk or source disk restore point when source resource is from a different region.
SourceResourceLocation *string `json:"sourceResourceLocation,omitempty"`
}
func (drpp DiskRestorePointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskRestorePointProperties.
DiskRestorePointReplicationStatus the instance view of a disk restore point.
type DiskRestorePointReplicationStatus struct {
// Status - The resource status information.
Status interface{} `json:"status,omitempty"`
}
DiskRestorePointRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiskRestorePointRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DiskRestorePointClient) (autorest.Response, error)
}
func (future *DiskRestorePointRevokeAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DiskSecurityProfile contains the security related information for the resource.
type DiskSecurityProfile struct {
// SecurityType - Possible values include: 'DiskSecurityTypesTrustedLaunch', 'DiskSecurityTypesConfidentialVMVMGuestStateOnlyEncryptedWithPlatformKey', 'DiskSecurityTypesConfidentialVMDiskEncryptedWithPlatformKey', 'DiskSecurityTypesConfidentialVMDiskEncryptedWithCustomerKey'
SecurityType DiskSecurityTypes `json:"securityType,omitempty"`
// SecureVMDiskEncryptionSetID - ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
SecureVMDiskEncryptionSetID *string `json:"secureVMDiskEncryptionSetId,omitempty"`
}
DiskSecurityTypes enumerates the values for disk security types.
type DiskSecurityTypes string
const (
// DiskSecurityTypesConfidentialVMDiskEncryptedWithCustomerKey Indicates Confidential VM disk with both OS
// disk and VM guest state encrypted with a customer managed key
DiskSecurityTypesConfidentialVMDiskEncryptedWithCustomerKey DiskSecurityTypes = "ConfidentialVM_DiskEncryptedWithCustomerKey"
// DiskSecurityTypesConfidentialVMDiskEncryptedWithPlatformKey Indicates Confidential VM disk with both OS
// disk and VM guest state encrypted with a platform managed key
DiskSecurityTypesConfidentialVMDiskEncryptedWithPlatformKey DiskSecurityTypes = "ConfidentialVM_DiskEncryptedWithPlatformKey"
// DiskSecurityTypesConfidentialVMVMGuestStateOnlyEncryptedWithPlatformKey Indicates Confidential VM disk
// with only VM guest state encrypted
DiskSecurityTypesConfidentialVMVMGuestStateOnlyEncryptedWithPlatformKey DiskSecurityTypes = "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
// DiskSecurityTypesTrustedLaunch Trusted Launch provides security features such as secure boot and virtual
// Trusted Platform Module (vTPM)
DiskSecurityTypesTrustedLaunch DiskSecurityTypes = "TrustedLaunch"
)
func PossibleDiskSecurityTypesValues() []DiskSecurityTypes
PossibleDiskSecurityTypesValues returns an array of possible values for the DiskSecurityTypes const type.
DiskSku the disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, or StandardSSD_ZRS.
type DiskSku struct {
// Name - The sku name. Possible values include: 'DiskStorageAccountTypesStandardLRS', 'DiskStorageAccountTypesPremiumLRS', 'DiskStorageAccountTypesStandardSSDLRS', 'DiskStorageAccountTypesUltraSSDLRS', 'DiskStorageAccountTypesPremiumZRS', 'DiskStorageAccountTypesStandardSSDZRS'
Name DiskStorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}
func (ds DiskSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskSku.
DiskState enumerates the values for disk state.
type DiskState string
const (
// DiskStateActiveSAS The disk currently has an Active SAS Uri associated with it.
DiskStateActiveSAS DiskState = "ActiveSAS"
// DiskStateActiveSASFrozen The disk is attached to a VM in hibernated state and has an active SAS URI
// associated with it.
DiskStateActiveSASFrozen DiskState = "ActiveSASFrozen"
// DiskStateActiveUpload A disk is created for upload and a write token has been issued for uploading to
// it.
DiskStateActiveUpload DiskState = "ActiveUpload"
// DiskStateAttached The disk is currently attached to a running VM.
DiskStateAttached DiskState = "Attached"
// DiskStateFrozen The disk is attached to a VM which is in hibernated state.
DiskStateFrozen DiskState = "Frozen"
// DiskStateReadyToUpload A disk is ready to be created by upload by requesting a write token.
DiskStateReadyToUpload DiskState = "ReadyToUpload"
// DiskStateReserved The disk is attached to a stopped-deallocated VM.
DiskStateReserved DiskState = "Reserved"
// DiskStateUnattached The disk is not being used and can be attached to a VM.
DiskStateUnattached DiskState = "Unattached"
)
func PossibleDiskStateValues() []DiskState
PossibleDiskStateValues returns an array of possible values for the DiskState const type.
DiskStorageAccountTypes enumerates the values for disk storage account types.
type DiskStorageAccountTypes string
const (
// DiskStorageAccountTypesPremiumLRS Premium SSD locally redundant storage. Best for production and
// performance sensitive workloads.
DiskStorageAccountTypesPremiumLRS DiskStorageAccountTypes = "Premium_LRS"
// DiskStorageAccountTypesPremiumZRS Premium SSD zone redundant storage. Best for the production workloads
// that need storage resiliency against zone failures.
DiskStorageAccountTypesPremiumZRS DiskStorageAccountTypes = "Premium_ZRS"
// DiskStorageAccountTypesStandardLRS Standard HDD locally redundant storage. Best for backup,
// non-critical, and infrequent access.
DiskStorageAccountTypesStandardLRS DiskStorageAccountTypes = "Standard_LRS"
// DiskStorageAccountTypesStandardSSDLRS Standard SSD locally redundant storage. Best for web servers,
// lightly used enterprise applications and dev/test.
DiskStorageAccountTypesStandardSSDLRS DiskStorageAccountTypes = "StandardSSD_LRS"
// DiskStorageAccountTypesStandardSSDZRS Standard SSD zone redundant storage. Best for web servers, lightly
// used enterprise applications and dev/test that need storage resiliency against zone failures.
DiskStorageAccountTypesStandardSSDZRS DiskStorageAccountTypes = "StandardSSD_ZRS"
// DiskStorageAccountTypesUltraSSDLRS 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.
DiskStorageAccountTypesUltraSSDLRS DiskStorageAccountTypes = "UltraSSD_LRS"
)
func PossibleDiskStorageAccountTypesValues() []DiskStorageAccountTypes
PossibleDiskStorageAccountTypesValues returns an array of possible values for the DiskStorageAccountTypes const type.
DiskUpdate disk update resource.
type DiskUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}
func (du DiskUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskUpdate.
func (du *DiskUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskUpdate struct.
DiskUpdateProperties disk resource update properties.
type DiskUpdateProperties struct {
// OsType - the Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
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.
MaxShares *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"`
// NetworkAccessPolicy - Possible values include: 'NetworkAccessPolicyAllowAll', 'NetworkAccessPolicyAllowPrivate', 'NetworkAccessPolicyDenyAll'
NetworkAccessPolicy NetworkAccessPolicy `json:"networkAccessPolicy,omitempty"`
// DiskAccessID - ARM id of the DiskAccess resource for using private endpoints on disks.
DiskAccessID *string `json:"diskAccessId,omitempty"`
// Tier - Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.
Tier *string `json:"tier,omitempty"`
// BurstingEnabled - Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.
BurstingEnabled *bool `json:"burstingEnabled,omitempty"`
// PurchasePlan - Purchase plan information to be added on the OS disk
PurchasePlan *PurchasePlan `json:"purchasePlan,omitempty"`
// SupportedCapabilities - List of supported capabilities to be added on the OS disk.
SupportedCapabilities *SupportedCapabilities `json:"supportedCapabilities,omitempty"`
// PropertyUpdatesInProgress - READ-ONLY; Properties of the disk for which update is pending.
PropertyUpdatesInProgress *PropertyUpdatesInProgress `json:"propertyUpdatesInProgress,omitempty"`
// SupportsHibernation - Indicates the OS on a disk supports hibernation.
SupportsHibernation *bool `json:"supportsHibernation,omitempty"`
// PublicNetworkAccess - Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// DataAccessAuthMode - Possible values include: 'DataAccessAuthModeAzureActiveDirectory', 'DataAccessAuthModeNone'
DataAccessAuthMode DataAccessAuthMode `json:"dataAccessAuthMode,omitempty"`
}
func (dup DiskUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskUpdateProperties.
DisksClient is the compute Client
type DisksClient struct {
BaseClient
}
func NewDisksClient(subscriptionID string) DisksClient
NewDisksClient creates an instance of the DisksClient client.
func NewDisksClientWithBaseURI(baseURI string, subscriptionID string) DisksClient
NewDisksClientWithBaseURI creates an instance of the DisksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DisksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (result DisksCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. disk - disk object supplied in the body of the Put disk operation.
func (client DisksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DisksClient) CreateOrUpdateResponder(resp *http.Response) (result Disk, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DisksClient) CreateOrUpdateSender(req *http.Request) (future DisksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Delete(ctx context.Context, resourceGroupName string, diskName string) (result DisksDeleteFuture, err error)
Delete deletes a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
func (client DisksClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DisksClient) DeleteResponder(resp *http.Response) (result 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.
func (client DisksClient) GetResponder(resp *http.Response) (result Disk, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DisksClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) GrantAccess(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (result DisksGrantAccessFuture, err error)
GrantAccess grants access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. grantAccessData - access data object supplied in the body of the get disk access operation.
func (client DisksClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
func (client DisksClient) GrantAccessResponder(resp *http.Response) (result AccessURI, err error)
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client DisksClient) GrantAccessSender(req *http.Request) (future DisksGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) List(ctx context.Context) (result DiskListPage, err error)
List lists all the disks under a subscription.
func (client DisksClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskListPage, err error)
ListByResourceGroup lists all the disks under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client DisksClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DisksClient) ListByResourceGroupResponder(resp *http.Response) (result DiskList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DisksClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) ListComplete(ctx context.Context) (result DiskListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client DisksClient) ListResponder(resp *http.Response) (result DiskList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DisksClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) RevokeAccess(ctx context.Context, resourceGroupName string, diskName string) (result DisksRevokeAccessFuture, err error)
RevokeAccess revokes access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
func (client DisksClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client DisksClient) RevokeAccessResponder(resp *http.Response) (result 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.
func (client DisksClient) UpdateResponder(resp *http.Response) (result Disk, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DisksClient) UpdateSender(req *http.Request) (future DisksUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}
func (future *DisksCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}
func (future *DisksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (AccessURI, error)
}
func (future *DisksGrantAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}
func (future *DisksRevokeAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}
func (future *DisksUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Encryption encryption at rest settings for disk or snapshot
type Encryption struct {
// DiskEncryptionSetID - ResourceId of the disk encryption set to use for enabling encryption at rest.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
// Type - Possible values include: 'EncryptionTypeEncryptionAtRestWithPlatformKey', 'EncryptionTypeEncryptionAtRestWithCustomerKey', 'EncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys'
Type EncryptionType `json:"type,omitempty"`
}
EncryptionImages optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
type EncryptionImages struct {
OsDiskImage *OSDiskImageEncryption `json:"osDiskImage,omitempty"`
// DataDiskImages - A list of encryption specifications for data disk images.
DataDiskImages *[]DataDiskImageEncryption `json:"dataDiskImages,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.
type EncryptionSetIdentity struct {
// Type - The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. Possible values include: 'DiskEncryptionSetIdentityTypeSystemAssigned', 'DiskEncryptionSetIdentityTypeNone'
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"`
}
func (esi EncryptionSetIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionSetIdentity.
EncryptionSetProperties ...
type EncryptionSetProperties struct {
// EncryptionType - Possible values include: 'DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey', 'DiskEncryptionSetTypeEncryptionAtRestWithPlatformAndCustomerKeys', 'DiskEncryptionSetTypeConfidentialVMEncryptedWithCustomerKey'
EncryptionType DiskEncryptionSetType `json:"encryptionType,omitempty"`
// ActiveKey - The key vault key which is currently used by this disk encryption set.
ActiveKey *KeyForDiskEncryptionSet `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 *[]KeyForDiskEncryptionSet `json:"previousKeys,omitempty"`
// ProvisioningState - READ-ONLY; The disk encryption set provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// RotationToLatestKeyVersionEnabled - Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
RotationToLatestKeyVersionEnabled *bool `json:"rotationToLatestKeyVersionEnabled,omitempty"`
// LastKeyRotationTimestamp - READ-ONLY; The time when the active key of this disk encryption set was updated.
LastKeyRotationTimestamp *date.Time `json:"lastKeyRotationTimestamp,omitempty"`
// AutoKeyRotationError - READ-ONLY; The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
AutoKeyRotationError *APIError `json:"autoKeyRotationError,omitempty"`
}
func (esp EncryptionSetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionSetProperties.
EncryptionSettingsCollection encryption settings for disk or snapshot
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"`
}
EncryptionSettingsElement encryption settings for one disk volume.
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"`
}
EncryptionType enumerates the values for encryption type.
type EncryptionType string
const (
// EncryptionTypeEncryptionAtRestWithCustomerKey Disk is encrypted at rest with Customer managed key that
// can be changed and revoked by a customer.
EncryptionTypeEncryptionAtRestWithCustomerKey EncryptionType = "EncryptionAtRestWithCustomerKey"
// EncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys Disk is encrypted at rest with 2 layers of
// encryption. One of the keys is Customer managed and the other key is Platform managed.
EncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys EncryptionType = "EncryptionAtRestWithPlatformAndCustomerKeys"
// EncryptionTypeEncryptionAtRestWithPlatformKey Disk is encrypted at rest with Platform managed key. It is
// the default encryption type. This is not a valid encryption type for disk encryption sets.
EncryptionTypeEncryptionAtRestWithPlatformKey EncryptionType = "EncryptionAtRestWithPlatformKey"
)
func PossibleEncryptionTypeValues() []EncryptionType
PossibleEncryptionTypeValues returns an array of possible values for the EncryptionType const type.
ExecutionState enumerates the values for execution state.
type ExecutionState string
const (
// ExecutionStateCanceled ...
ExecutionStateCanceled ExecutionState = "Canceled"
// ExecutionStateFailed ...
ExecutionStateFailed ExecutionState = "Failed"
// ExecutionStatePending ...
ExecutionStatePending ExecutionState = "Pending"
// ExecutionStateRunning ...
ExecutionStateRunning ExecutionState = "Running"
// ExecutionStateSucceeded ...
ExecutionStateSucceeded ExecutionState = "Succeeded"
// ExecutionStateTimedOut ...
ExecutionStateTimedOut ExecutionState = "TimedOut"
// ExecutionStateUnknown ...
ExecutionStateUnknown ExecutionState = "Unknown"
)
func PossibleExecutionStateValues() []ExecutionState
PossibleExecutionStateValues returns an array of possible values for the ExecutionState const type.
ExpandTypesForGetCapacityReservationGroups enumerates the values for expand types for get capacity reservation groups.
type ExpandTypesForGetCapacityReservationGroups string
const (
// ExpandTypesForGetCapacityReservationGroupsVirtualMachineScaleSetVMsref ...
ExpandTypesForGetCapacityReservationGroupsVirtualMachineScaleSetVMsref ExpandTypesForGetCapacityReservationGroups = "virtualMachineScaleSetVMs/$ref"
// ExpandTypesForGetCapacityReservationGroupsVirtualMachinesref ...
ExpandTypesForGetCapacityReservationGroupsVirtualMachinesref ExpandTypesForGetCapacityReservationGroups = "virtualMachines/$ref"
)
func PossibleExpandTypesForGetCapacityReservationGroupsValues() []ExpandTypesForGetCapacityReservationGroups
PossibleExpandTypesForGetCapacityReservationGroupsValues returns an array of possible values for the ExpandTypesForGetCapacityReservationGroups const type.
ExpandTypesForGetVMScaleSets enumerates the values for expand types for get vm scale sets.
type ExpandTypesForGetVMScaleSets string
const (
// ExpandTypesForGetVMScaleSetsUserData ...
ExpandTypesForGetVMScaleSetsUserData ExpandTypesForGetVMScaleSets = "userData"
)
func PossibleExpandTypesForGetVMScaleSetsValues() []ExpandTypesForGetVMScaleSets
PossibleExpandTypesForGetVMScaleSetsValues returns an array of possible values for the ExpandTypesForGetVMScaleSets const type.
ExtendedLocation the complex type of the extended location.
type ExtendedLocation struct {
// Name - The name of the extended location.
Name *string `json:"name,omitempty"`
// Type - The type of the extended location. Possible values include: 'ExtendedLocationTypesEdgeZone'
Type ExtendedLocationTypes `json:"type,omitempty"`
}
ExtendedLocationType enumerates the values for extended location type.
type ExtendedLocationType string
const (
// ExtendedLocationTypeEdgeZone ...
ExtendedLocationTypeEdgeZone ExtendedLocationType = "EdgeZone"
)
func PossibleExtendedLocationTypeValues() []ExtendedLocationType
PossibleExtendedLocationTypeValues returns an array of possible values for the ExtendedLocationType const type.
ExtendedLocationTypes enumerates the values for extended location types.
type ExtendedLocationTypes string
const (
// ExtendedLocationTypesEdgeZone ...
ExtendedLocationTypesEdgeZone ExtendedLocationTypes = "EdgeZone"
)
func PossibleExtendedLocationTypesValues() []ExtendedLocationTypes
PossibleExtendedLocationTypesValues returns an array of possible values for the ExtendedLocationTypes const type.
Extension describes a cloud service Extension.
type Extension struct {
// Name - The name of the extension.
Name *string `json:"name,omitempty"`
Properties *CloudServiceExtensionProperties `json:"properties,omitempty"`
}
GalleriesClient is the compute Client
type GalleriesClient struct {
BaseClient
}
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, selectParameter SelectPermissions, expand GalleryExpandParams) (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. selectParameter - the select expression to apply on the operation. expand - the expand query option to apply on the operation.
func (client GalleriesClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, selectParameter SelectPermissions, expand GalleryExpandParams) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleriesClient) GetResponder(resp *http.Response) (result Gallery, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GalleriesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client 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.
func (client GalleriesClient) 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 GalleriesClient) ListComplete(ctx context.Context) (result GalleryListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleriesClient) ListPreparer(ctx context.Context) (*http.Request, error)
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.
func (client GalleriesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client 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.
func (client GalleriesClient) UpdateResponder(resp *http.Response) (result Gallery, err error)
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.
GalleriesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *GalleriesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleriesDeleteFuture 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)
}
func (future *GalleriesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleriesUpdateFuture 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)
}
func (future *GalleriesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Gallery specifies information about the Shared Image Gallery that you want to create or update.
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"`
}
func (g Gallery) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Gallery.
func (g *Gallery) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Gallery struct.
GalleryApplication specifies information about the gallery Application Definition that you want to create or update.
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"`
}
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.
GalleryApplicationList the List Gallery Applications operation response.
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"`
}
func (gal GalleryApplicationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryApplicationListIterator provides access to a complete listing of GalleryApplication values.
type GalleryApplicationListIterator struct {
// contains filtered or unexported fields
}
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.
GalleryApplicationListPage contains a page of GalleryApplication values.
type GalleryApplicationListPage struct {
// contains filtered or unexported fields
}
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.
GalleryApplicationProperties describes the properties of a gallery Application Definition.
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: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
SupportedOSType OperatingSystemTypes `json:"supportedOSType,omitempty"`
}
GalleryApplicationUpdate specifies information about the gallery Application Definition that you want to update.
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"`
}
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.
GalleryApplicationVersion specifies information about the gallery Application Version that you want to create or update.
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"`
}
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.
GalleryApplicationVersionList the List Gallery Application version operation response.
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"`
}
func (gavl GalleryApplicationVersionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryApplicationVersionListIterator provides access to a complete listing of GalleryApplicationVersion values.
type GalleryApplicationVersionListIterator struct {
// contains filtered or unexported fields
}
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.
GalleryApplicationVersionListPage contains a page of GalleryApplicationVersion values.
type GalleryApplicationVersionListPage struct {
// contains filtered or unexported fields
}
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.
GalleryApplicationVersionProperties describes the properties of a gallery image version.
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"`
}
func (gavp GalleryApplicationVersionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersionProperties.
GalleryApplicationVersionPublishingProfile the publishing profile of a gallery image version.
type GalleryApplicationVersionPublishingProfile struct {
Source *UserArtifactSource `json:"source,omitempty"`
ManageActions *UserArtifactManage `json:"manageActions,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"`
// ReplicationMode - Optional parameter which specifies the mode to be used for replication. This property is not updatable. Possible values include: 'ReplicationModeFull', 'ReplicationModeShallow'
ReplicationMode ReplicationMode `json:"replicationMode,omitempty"`
// TargetExtendedLocations - The target extended locations where the Image Version is going to be replicated to. This property is updatable.
TargetExtendedLocations *[]GalleryTargetExtendedLocation `json:"targetExtendedLocations,omitempty"`
}
func (gavpp GalleryApplicationVersionPublishingProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryApplicationVersionPublishingProfile.
GalleryApplicationVersionUpdate specifies information about the gallery Application Version that you want to update.
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"`
}
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.
GalleryApplicationVersionsClient is the compute Client
type GalleryApplicationVersionsClient struct {
BaseClient
}
func NewGalleryApplicationVersionsClient(subscriptionID string) GalleryApplicationVersionsClient
NewGalleryApplicationVersionsClient creates an instance of the GalleryApplicationVersionsClient client.
func NewGalleryApplicationVersionsClientWithBaseURI(baseURI string, subscriptionID string) GalleryApplicationVersionsClient
NewGalleryApplicationVersionsClientWithBaseURI creates an instance of the GalleryApplicationVersionsClient 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 GalleryApplicationVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, galleryApplicationVersion GalleryApplicationVersion) (result GalleryApplicationVersionsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery Application Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition resides. galleryApplicationName - the name of the gallery Application Definition in which the Application Version is to be created. galleryApplicationVersionName - the name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> galleryApplicationVersion - parameters supplied to the create or update gallery Application Version operation.
func (client GalleryApplicationVersionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, galleryApplicationVersion GalleryApplicationVersion) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryApplicationVersionsClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryApplicationVersion, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryApplicationVersionsClient) CreateOrUpdateSender(req *http.Request) (future GalleryApplicationVersionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationVersionsClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string) (result GalleryApplicationVersionsDeleteFuture, err error)
Delete delete a gallery Application Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition resides. galleryApplicationName - the name of the gallery Application Definition in which the Application Version resides. galleryApplicationVersionName - the name of the gallery Application Version to be deleted.
func (client GalleryApplicationVersionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryApplicationVersionsClient) 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 GalleryApplicationVersionsClient) DeleteSender(req *http.Request) (future GalleryApplicationVersionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationVersionsClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, expand ReplicationStatusTypes) (result GalleryApplicationVersion, err error)
Get retrieves information about a gallery Application Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition resides. galleryApplicationName - the name of the gallery Application Definition in which the Application Version resides. galleryApplicationVersionName - the name of the gallery Application Version to be retrieved. expand - the expand expression to apply on the operation.
func (client GalleryApplicationVersionsClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, expand ReplicationStatusTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryApplicationVersionsClient) GetResponder(resp *http.Response) (result GalleryApplicationVersion, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GalleryApplicationVersionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationVersionsClient) ListByGalleryApplication(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (result GalleryApplicationVersionListPage, err error)
ListByGalleryApplication list gallery Application Versions in a gallery Application Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition resides. galleryApplicationName - the name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed.
func (client GalleryApplicationVersionsClient) ListByGalleryApplicationComplete(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (result GalleryApplicationVersionListIterator, err error)
ListByGalleryApplicationComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryApplicationVersionsClient) ListByGalleryApplicationPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (*http.Request, error)
ListByGalleryApplicationPreparer prepares the ListByGalleryApplication request.
func (client GalleryApplicationVersionsClient) ListByGalleryApplicationResponder(resp *http.Response) (result GalleryApplicationVersionList, err error)
ListByGalleryApplicationResponder handles the response to the ListByGalleryApplication request. The method always closes the http.Response Body.
func (client GalleryApplicationVersionsClient) ListByGalleryApplicationSender(req *http.Request) (*http.Response, error)
ListByGalleryApplicationSender sends the ListByGalleryApplication request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationVersionsClient) Update(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, galleryApplicationVersion GalleryApplicationVersionUpdate) (result GalleryApplicationVersionsUpdateFuture, err error)
Update update a gallery Application Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition resides. galleryApplicationName - the name of the gallery Application Definition in which the Application Version is to be updated. galleryApplicationVersionName - the name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> galleryApplicationVersion - parameters supplied to the update gallery Application Version operation.
func (client GalleryApplicationVersionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplicationVersionName string, galleryApplicationVersion GalleryApplicationVersionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GalleryApplicationVersionsClient) UpdateResponder(resp *http.Response) (result GalleryApplicationVersion, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GalleryApplicationVersionsClient) UpdateSender(req *http.Request) (future GalleryApplicationVersionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GalleryApplicationVersionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationVersionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationVersionsClient) (GalleryApplicationVersion, error)
}
func (future *GalleryApplicationVersionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryApplicationVersionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationVersionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationVersionsClient) (autorest.Response, error)
}
func (future *GalleryApplicationVersionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryApplicationVersionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationVersionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationVersionsClient) (GalleryApplicationVersion, error)
}
func (future *GalleryApplicationVersionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryApplicationsClient is the compute Client
type GalleryApplicationsClient struct {
BaseClient
}
func NewGalleryApplicationsClient(subscriptionID string) GalleryApplicationsClient
NewGalleryApplicationsClient creates an instance of the GalleryApplicationsClient client.
func NewGalleryApplicationsClientWithBaseURI(baseURI string, subscriptionID string) GalleryApplicationsClient
NewGalleryApplicationsClientWithBaseURI creates an instance of the GalleryApplicationsClient 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 GalleryApplicationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplication GalleryApplication) (result GalleryApplicationsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery Application Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition is to be created. galleryApplicationName - the name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. galleryApplication - parameters supplied to the create or update gallery Application operation.
func (client GalleryApplicationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplication GalleryApplication) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryApplicationsClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryApplication, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryApplicationsClient) CreateOrUpdateSender(req *http.Request) (future GalleryApplicationsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationsClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (result GalleryApplicationsDeleteFuture, err error)
Delete delete a gallery Application. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition is to be deleted. galleryApplicationName - the name of the gallery Application Definition to be deleted.
func (client GalleryApplicationsClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryApplicationsClient) 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 GalleryApplicationsClient) DeleteSender(req *http.Request) (future GalleryApplicationsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationsClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (result GalleryApplication, err error)
Get retrieves information about a gallery Application Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery from which the Application Definitions are to be retrieved. galleryApplicationName - the name of the gallery Application Definition to be retrieved.
func (client GalleryApplicationsClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryApplicationsClient) GetResponder(resp *http.Response) (result GalleryApplication, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GalleryApplicationsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationsClient) ListByGallery(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryApplicationListPage, err error)
ListByGallery list gallery Application Definitions in a gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery from which Application Definitions are to be listed.
func (client GalleryApplicationsClient) ListByGalleryComplete(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryApplicationListIterator, err error)
ListByGalleryComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryApplicationsClient) ListByGalleryPreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
ListByGalleryPreparer prepares the ListByGallery request.
func (client GalleryApplicationsClient) ListByGalleryResponder(resp *http.Response) (result GalleryApplicationList, err error)
ListByGalleryResponder handles the response to the ListByGallery request. The method always closes the http.Response Body.
func (client GalleryApplicationsClient) ListByGallerySender(req *http.Request) (*http.Response, error)
ListByGallerySender sends the ListByGallery request. The method will close the http.Response Body if it receives an error.
func (client GalleryApplicationsClient) Update(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplication GalleryApplicationUpdate) (result GalleryApplicationsUpdateFuture, err error)
Update update a gallery Application Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Application Gallery in which the Application Definition is to be updated. galleryApplicationName - the name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. galleryApplication - parameters supplied to the update gallery Application operation.
func (client GalleryApplicationsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryApplicationName string, galleryApplication GalleryApplicationUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GalleryApplicationsClient) UpdateResponder(resp *http.Response) (result GalleryApplication, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GalleryApplicationsClient) UpdateSender(req *http.Request) (future GalleryApplicationsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GalleryApplicationsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationsClient) (GalleryApplication, error)
}
func (future *GalleryApplicationsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryApplicationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationsClient) (autorest.Response, error)
}
func (future *GalleryApplicationsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryApplicationsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryApplicationsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryApplicationsClient) (GalleryApplication, error)
}
func (future *GalleryApplicationsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryArtifactPublishingProfileBase describes the basic gallery artifact publishing profile.
type GalleryArtifactPublishingProfileBase struct {
// TargetRegions - The target regions where the Image Version is going to be replicated to. This property is updatable.
TargetRegions *[]TargetRegion `json:"targetRegions,omitempty"`
// 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"`
// ReplicationMode - Optional parameter which specifies the mode to be used for replication. This property is not updatable. Possible values include: 'ReplicationModeFull', 'ReplicationModeShallow'
ReplicationMode ReplicationMode `json:"replicationMode,omitempty"`
// TargetExtendedLocations - The target extended locations where the Image Version is going to be replicated to. This property is updatable.
TargetExtendedLocations *[]GalleryTargetExtendedLocation `json:"targetExtendedLocations,omitempty"`
}
func (gappb GalleryArtifactPublishingProfileBase) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryArtifactPublishingProfileBase.
GalleryArtifactSource the source image from which the Image Version is going to be created.
type GalleryArtifactSource struct {
ManagedImage *ManagedArtifact `json:"managedImage,omitempty"`
}
GalleryArtifactVersionSource the gallery artifact version source.
type GalleryArtifactVersionSource struct {
// ID - The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource.
ID *string `json:"id,omitempty"`
// URI - The uri of the gallery artifact version source. Currently used to specify vhd/blob source.
URI *string `json:"uri,omitempty"`
}
GalleryDataDiskImage this is the data disk image.
type GalleryDataDiskImage 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"`
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
Source *GalleryArtifactVersionSource `json:"source,omitempty"`
}
func (gddi GalleryDataDiskImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryDataDiskImage.
GalleryDiskImage this is the disk image base class.
type GalleryDiskImage struct {
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
Source *GalleryArtifactVersionSource `json:"source,omitempty"`
}
func (gdi GalleryDiskImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryDiskImage.
GalleryExpandParams enumerates the values for gallery expand params.
type GalleryExpandParams string
const (
// GalleryExpandParamsSharingProfileGroups ...
GalleryExpandParamsSharingProfileGroups GalleryExpandParams = "SharingProfile/Groups"
)
func PossibleGalleryExpandParamsValues() []GalleryExpandParams
PossibleGalleryExpandParamsValues returns an array of possible values for the GalleryExpandParams const type.
GalleryExtendedLocation the name of the extended location.
type GalleryExtendedLocation struct {
Name *string `json:"name,omitempty"`
// Type - Possible values include: 'GalleryExtendedLocationTypeEdgeZone', 'GalleryExtendedLocationTypeUnknown'
Type GalleryExtendedLocationType `json:"type,omitempty"`
}
GalleryExtendedLocationType enumerates the values for gallery extended location type.
type GalleryExtendedLocationType string
const (
// GalleryExtendedLocationTypeEdgeZone ...
GalleryExtendedLocationTypeEdgeZone GalleryExtendedLocationType = "EdgeZone"
// GalleryExtendedLocationTypeUnknown ...
GalleryExtendedLocationTypeUnknown GalleryExtendedLocationType = "Unknown"
)
func PossibleGalleryExtendedLocationTypeValues() []GalleryExtendedLocationType
PossibleGalleryExtendedLocationTypeValues returns an array of possible values for the GalleryExtendedLocationType const type.
GalleryIdentifier describes the gallery unique name.
type GalleryIdentifier struct {
// UniqueName - READ-ONLY; The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
UniqueName *string `json:"uniqueName,omitempty"`
}
func (gi GalleryIdentifier) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryIdentifier.
GalleryImage specifies information about the gallery image definition that you want to create or update.
type GalleryImage struct {
autorest.Response `json:"-"`
*GalleryImageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (gi GalleryImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImage.
func (gi *GalleryImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImage struct.
GalleryImageFeature a feature for gallery image.
type GalleryImageFeature struct {
// Name - The name of the gallery image feature.
Name *string `json:"name,omitempty"`
// Value - The value of the gallery image feature.
Value *string `json:"value,omitempty"`
}
GalleryImageIdentifier this is the gallery image definition identifier.
type GalleryImageIdentifier struct {
// Publisher - The name of the gallery image definition publisher.
Publisher *string `json:"publisher,omitempty"`
// Offer - The name of the gallery image definition offer.
Offer *string `json:"offer,omitempty"`
// Sku - The name of the gallery image definition SKU.
Sku *string `json:"sku,omitempty"`
}
GalleryImageList the List Gallery Images operation response.
type GalleryImageList struct {
autorest.Response `json:"-"`
// Value - A list of Shared Image Gallery images.
Value *[]GalleryImage `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions.
NextLink *string `json:"nextLink,omitempty"`
}
func (gil GalleryImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryImageListIterator provides access to a complete listing of GalleryImage values.
type GalleryImageListIterator struct {
// contains filtered or unexported fields
}
func NewGalleryImageListIterator(page GalleryImageListPage) GalleryImageListIterator
Creates a new instance of the GalleryImageListIterator type.
func (iter *GalleryImageListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *GalleryImageListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter GalleryImageListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryImageListIterator) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (iter GalleryImageListIterator) Value() GalleryImage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
GalleryImageListPage contains a page of GalleryImage values.
type GalleryImageListPage struct {
// contains filtered or unexported fields
}
func NewGalleryImageListPage(cur GalleryImageList, getNextPage func(context.Context, GalleryImageList) (GalleryImageList, error)) GalleryImageListPage
Creates a new instance of the GalleryImageListPage type.
func (page *GalleryImageListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *GalleryImageListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page GalleryImageListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryImageListPage) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (page GalleryImageListPage) Values() []GalleryImage
Values returns the slice of values for the current page or nil if there are no values.
GalleryImageProperties describes the properties of a gallery image definition.
type GalleryImageProperties struct {
// Description - The description of this gallery image definition resource. This property is updatable.
Description *string `json:"description,omitempty"`
// Eula - The Eula agreement for the gallery image definition.
Eula *string `json:"eula,omitempty"`
// PrivacyStatementURI - The privacy statement uri.
PrivacyStatementURI *string `json:"privacyStatementUri,omitempty"`
// ReleaseNoteURI - The release note uri.
ReleaseNoteURI *string `json:"releaseNoteUri,omitempty"`
// OsType - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Possible values include: 'OperatingSystemStateTypesGeneralized', 'OperatingSystemStateTypesSpecialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// EndOfLifeDate - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
Identifier *GalleryImageIdentifier `json:"identifier,omitempty"`
Recommended *RecommendedMachineConfiguration `json:"recommended,omitempty"`
Disallowed *Disallowed `json:"disallowed,omitempty"`
PurchasePlan *ImagePurchasePlan `json:"purchasePlan,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningState2Creating', 'ProvisioningState2Updating', 'ProvisioningState2Failed', 'ProvisioningState2Succeeded', 'ProvisioningState2Deleting', 'ProvisioningState2Migrating'
ProvisioningState ProvisioningState2 `json:"provisioningState,omitempty"`
// Features - A list of gallery image features.
Features *[]GalleryImageFeature `json:"features,omitempty"`
// Architecture - The architecture of the image. Applicable to OS disks only. Possible values include: 'ArchitectureX64', 'ArchitectureArm64'
Architecture Architecture `json:"architecture,omitempty"`
}
func (gip GalleryImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageProperties.
GalleryImageUpdate specifies information about the gallery image definition that you want to update.
type GalleryImageUpdate struct {
*GalleryImageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (giu GalleryImageUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageUpdate.
func (giu *GalleryImageUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImageUpdate struct.
GalleryImageVersion specifies information about the gallery image version that you want to create or update.
type GalleryImageVersion struct {
autorest.Response `json:"-"`
*GalleryImageVersionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (giv GalleryImageVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersion.
func (giv *GalleryImageVersion) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImageVersion struct.
GalleryImageVersionList the List Gallery Image version operation response.
type GalleryImageVersionList struct {
autorest.Response `json:"-"`
// Value - A list of gallery image versions.
Value *[]GalleryImageVersion `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions.
NextLink *string `json:"nextLink,omitempty"`
}
func (givl GalleryImageVersionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryImageVersionListIterator provides access to a complete listing of GalleryImageVersion values.
type GalleryImageVersionListIterator struct {
// contains filtered or unexported fields
}
func NewGalleryImageVersionListIterator(page GalleryImageVersionListPage) GalleryImageVersionListIterator
Creates a new instance of the GalleryImageVersionListIterator type.
func (iter *GalleryImageVersionListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *GalleryImageVersionListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter GalleryImageVersionListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryImageVersionListIterator) Response() GalleryImageVersionList
Response returns the raw server response from the last page request.
func (iter GalleryImageVersionListIterator) Value() GalleryImageVersion
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
GalleryImageVersionListPage contains a page of GalleryImageVersion values.
type GalleryImageVersionListPage struct {
// contains filtered or unexported fields
}
func NewGalleryImageVersionListPage(cur GalleryImageVersionList, getNextPage func(context.Context, GalleryImageVersionList) (GalleryImageVersionList, error)) GalleryImageVersionListPage
Creates a new instance of the GalleryImageVersionListPage type.
func (page *GalleryImageVersionListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *GalleryImageVersionListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page GalleryImageVersionListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryImageVersionListPage) Response() GalleryImageVersionList
Response returns the raw server response from the last page request.
func (page GalleryImageVersionListPage) Values() []GalleryImageVersion
Values returns the slice of values for the current page or nil if there are no values.
GalleryImageVersionProperties describes the properties of a gallery image version.
type GalleryImageVersionProperties struct {
PublishingProfile *GalleryImageVersionPublishingProfile `json:"publishingProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningState3Creating', 'ProvisioningState3Updating', 'ProvisioningState3Failed', 'ProvisioningState3Succeeded', 'ProvisioningState3Deleting', 'ProvisioningState3Migrating'
ProvisioningState ProvisioningState3 `json:"provisioningState,omitempty"`
StorageProfile *GalleryImageVersionStorageProfile `json:"storageProfile,omitempty"`
// ReplicationStatus - READ-ONLY
ReplicationStatus *ReplicationStatus `json:"replicationStatus,omitempty"`
}
func (givp GalleryImageVersionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersionProperties.
GalleryImageVersionPublishingProfile the publishing profile of a gallery image Version.
type GalleryImageVersionPublishingProfile struct {
// 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"`
// ReplicationMode - Optional parameter which specifies the mode to be used for replication. This property is not updatable. Possible values include: 'ReplicationModeFull', 'ReplicationModeShallow'
ReplicationMode ReplicationMode `json:"replicationMode,omitempty"`
// TargetExtendedLocations - The target extended locations where the Image Version is going to be replicated to. This property is updatable.
TargetExtendedLocations *[]GalleryTargetExtendedLocation `json:"targetExtendedLocations,omitempty"`
}
func (givpp GalleryImageVersionPublishingProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersionPublishingProfile.
GalleryImageVersionStorageProfile this is the storage profile of a Gallery Image Version.
type GalleryImageVersionStorageProfile struct {
Source *GalleryArtifactVersionSource `json:"source,omitempty"`
OsDiskImage *GalleryOSDiskImage `json:"osDiskImage,omitempty"`
// DataDiskImages - A list of data disk images.
DataDiskImages *[]GalleryDataDiskImage `json:"dataDiskImages,omitempty"`
}
GalleryImageVersionUpdate specifies information about the gallery image version that you want to update.
type GalleryImageVersionUpdate struct {
*GalleryImageVersionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (givu GalleryImageVersionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersionUpdate.
func (givu *GalleryImageVersionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImageVersionUpdate struct.
GalleryImageVersionsClient is the compute Client
type GalleryImageVersionsClient struct {
BaseClient
}
func NewGalleryImageVersionsClient(subscriptionID string) GalleryImageVersionsClient
NewGalleryImageVersionsClient creates an instance of the GalleryImageVersionsClient client.
func NewGalleryImageVersionsClientWithBaseURI(baseURI string, subscriptionID string) GalleryImageVersionsClient
NewGalleryImageVersionsClientWithBaseURI creates an instance of the GalleryImageVersionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleryImageVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersion) (result GalleryImageVersionsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery image version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery image definition in which the Image Version is to be created. galleryImageVersionName - the name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> galleryImageVersion - parameters supplied to the create or update gallery image version operation.
func (client GalleryImageVersionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersion) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryImageVersionsClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryImageVersion, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) CreateOrUpdateSender(req *http.Request) (future GalleryImageVersionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string) (result GalleryImageVersionsDeleteFuture, err error)
Delete delete a gallery image version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery image definition in which the Image Version resides. galleryImageVersionName - the name of the gallery image version to be deleted.
func (client GalleryImageVersionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryImageVersionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) DeleteSender(req *http.Request) (future GalleryImageVersionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, expand ReplicationStatusTypes) (result GalleryImageVersion, err error)
Get retrieves information about a gallery image version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery image definition in which the Image Version resides. galleryImageVersionName - the name of the gallery image version to be retrieved. expand - the expand expression to apply on the operation.
func (client GalleryImageVersionsClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, expand ReplicationStatusTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryImageVersionsClient) GetResponder(resp *http.Response) (result GalleryImageVersion, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) ListByGalleryImage(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImageVersionListPage, err error)
ListByGalleryImage list gallery image versions in a gallery image definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed.
func (client GalleryImageVersionsClient) ListByGalleryImageComplete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImageVersionListIterator, err error)
ListByGalleryImageComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryImageVersionsClient) ListByGalleryImagePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
ListByGalleryImagePreparer prepares the ListByGalleryImage request.
func (client GalleryImageVersionsClient) ListByGalleryImageResponder(resp *http.Response) (result GalleryImageVersionList, err error)
ListByGalleryImageResponder handles the response to the ListByGalleryImage request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) ListByGalleryImageSender(req *http.Request) (*http.Response, error)
ListByGalleryImageSender sends the ListByGalleryImage request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) Update(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersionUpdate) (result GalleryImageVersionsUpdateFuture, err error)
Update update a gallery image version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery image definition in which the Image Version is to be updated. galleryImageVersionName - the name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> galleryImageVersion - parameters supplied to the update gallery image version operation.
func (client GalleryImageVersionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GalleryImageVersionsClient) UpdateResponder(resp *http.Response) (result GalleryImageVersion, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) UpdateSender(req *http.Request) (future GalleryImageVersionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GalleryImageVersionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImageVersionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImageVersionsClient) (GalleryImageVersion, error)
}
func (future *GalleryImageVersionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImageVersionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImageVersionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImageVersionsClient) (autorest.Response, error)
}
func (future *GalleryImageVersionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImageVersionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImageVersionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImageVersionsClient) (GalleryImageVersion, error)
}
func (future *GalleryImageVersionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImagesClient is the compute Client
type GalleryImagesClient struct {
BaseClient
}
func NewGalleryImagesClient(subscriptionID string) GalleryImagesClient
NewGalleryImagesClient creates an instance of the GalleryImagesClient client.
func NewGalleryImagesClientWithBaseURI(baseURI string, subscriptionID string) GalleryImagesClient
NewGalleryImagesClientWithBaseURI creates an instance of the GalleryImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleryImagesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImage) (result GalleryImagesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery image definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition is to be created. galleryImageName - the name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. galleryImage - parameters supplied to the create or update gallery image operation.
func (client GalleryImagesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImage) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryImagesClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryImage, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryImagesClient) CreateOrUpdateSender(req *http.Request) (future GalleryImagesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImagesDeleteFuture, err error)
Delete delete a gallery image. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition is to be deleted. galleryImageName - the name of the gallery image definition to be deleted.
func (client GalleryImagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryImagesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client GalleryImagesClient) DeleteSender(req *http.Request) (future GalleryImagesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImage, err error)
Get retrieves information about a gallery image definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery from which the Image Definitions are to be retrieved. galleryImageName - the name of the gallery image definition to be retrieved.
func (client GalleryImagesClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryImagesClient) GetResponder(resp *http.Response) (result GalleryImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GalleryImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) ListByGallery(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryImageListPage, err error)
ListByGallery list gallery image definitions in a gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery from which Image Definitions are to be listed.
func (client GalleryImagesClient) ListByGalleryComplete(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryImageListIterator, err error)
ListByGalleryComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryImagesClient) ListByGalleryPreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
ListByGalleryPreparer prepares the ListByGallery request.
func (client GalleryImagesClient) ListByGalleryResponder(resp *http.Response) (result GalleryImageList, err error)
ListByGalleryResponder handles the response to the ListByGallery request. The method always closes the http.Response Body.
func (client GalleryImagesClient) ListByGallerySender(req *http.Request) (*http.Response, error)
ListByGallerySender sends the ListByGallery request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) Update(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImageUpdate) (result GalleryImagesUpdateFuture, err error)
Update update a gallery image definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition is to be updated. galleryImageName - the name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. galleryImage - parameters supplied to the update gallery image operation.
func (client GalleryImagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImageUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GalleryImagesClient) UpdateResponder(resp *http.Response) (result GalleryImage, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GalleryImagesClient) UpdateSender(req *http.Request) (future GalleryImagesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GalleryImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImagesClient) (GalleryImage, error)
}
func (future *GalleryImagesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImagesClient) (autorest.Response, error)
}
func (future *GalleryImagesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImagesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImagesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImagesClient) (GalleryImage, error)
}
func (future *GalleryImagesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryList the List Galleries operation response.
type GalleryList struct {
autorest.Response `json:"-"`
// Value - A list of galleries.
Value *[]Gallery `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.
NextLink *string `json:"nextLink,omitempty"`
}
func (gl GalleryList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryListIterator provides access to a complete listing of Gallery values.
type GalleryListIterator struct {
// contains filtered or unexported fields
}
func NewGalleryListIterator(page GalleryListPage) GalleryListIterator
Creates a new instance of the GalleryListIterator type.
func (iter *GalleryListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *GalleryListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter GalleryListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryListIterator) Response() GalleryList
Response returns the raw server response from the last page request.
func (iter GalleryListIterator) Value() Gallery
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
GalleryListPage contains a page of Gallery values.
type GalleryListPage struct {
// contains filtered or unexported fields
}
func NewGalleryListPage(cur GalleryList, getNextPage func(context.Context, GalleryList) (GalleryList, error)) GalleryListPage
Creates a new instance of the GalleryListPage type.
func (page *GalleryListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *GalleryListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page GalleryListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryListPage) Response() GalleryList
Response returns the raw server response from the last page request.
func (page GalleryListPage) Values() []Gallery
Values returns the slice of values for the current page or nil if there are no values.
GalleryOSDiskImage this is the OS disk image.
type GalleryOSDiskImage struct {
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
Source *GalleryArtifactVersionSource `json:"source,omitempty"`
}
func (godi GalleryOSDiskImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryOSDiskImage.
GalleryProperties describes the properties of a Shared Image Gallery.
type GalleryProperties struct {
// Description - The description of this Shared Image Gallery resource. This property is updatable.
Description *string `json:"description,omitempty"`
Identifier *GalleryIdentifier `json:"identifier,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateFailed', 'ProvisioningStateSucceeded', 'ProvisioningStateDeleting', 'ProvisioningStateMigrating'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
SharingProfile *SharingProfile `json:"sharingProfile,omitempty"`
SoftDeletePolicy *SoftDeletePolicy `json:"softDeletePolicy,omitempty"`
// SharingStatus - READ-ONLY
SharingStatus *SharingStatus `json:"sharingStatus,omitempty"`
}
func (gp GalleryProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryProperties.
GallerySharingPermissionTypes enumerates the values for gallery sharing permission types.
type GallerySharingPermissionTypes string
const (
// GallerySharingPermissionTypesGroups ...
GallerySharingPermissionTypesGroups GallerySharingPermissionTypes = "Groups"
// GallerySharingPermissionTypesPrivate ...
GallerySharingPermissionTypesPrivate GallerySharingPermissionTypes = "Private"
)
func PossibleGallerySharingPermissionTypesValues() []GallerySharingPermissionTypes
PossibleGallerySharingPermissionTypesValues returns an array of possible values for the GallerySharingPermissionTypes const type.
GallerySharingProfileClient is the compute Client
type GallerySharingProfileClient struct {
BaseClient
}
func NewGallerySharingProfileClient(subscriptionID string) GallerySharingProfileClient
NewGallerySharingProfileClient creates an instance of the GallerySharingProfileClient client.
func NewGallerySharingProfileClientWithBaseURI(baseURI string, subscriptionID string) GallerySharingProfileClient
NewGallerySharingProfileClientWithBaseURI creates an instance of the GallerySharingProfileClient 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 GallerySharingProfileClient) Update(ctx context.Context, resourceGroupName string, galleryName string, sharingUpdate SharingUpdate) (result GallerySharingProfileUpdateFuture, err error)
Update update sharing profile of a gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery. sharingUpdate - parameters supplied to the update gallery sharing profile.
func (client GallerySharingProfileClient) UpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, sharingUpdate SharingUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GallerySharingProfileClient) UpdateResponder(resp *http.Response) (result SharingUpdate, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GallerySharingProfileClient) UpdateSender(req *http.Request) (future GallerySharingProfileUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GallerySharingProfileUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GallerySharingProfileUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GallerySharingProfileClient) (SharingUpdate, error)
}
func (future *GallerySharingProfileUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryTargetExtendedLocation ...
type GalleryTargetExtendedLocation struct {
// Name - The name of the region.
Name *string `json:"name,omitempty"`
ExtendedLocation *GalleryExtendedLocation `json:"extendedLocation,omitempty"`
// ExtendedLocationReplicaCount - The number of replicas of the Image Version to be created per extended location. This property is updatable.
ExtendedLocationReplicaCount *int32 `json:"extendedLocationReplicaCount,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"`
Encryption *EncryptionImages `json:"encryption,omitempty"`
}
GalleryUpdate specifies information about the Shared Image Gallery that you want to update.
type GalleryUpdate struct {
*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"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (gu GalleryUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryUpdate.
func (gu *GalleryUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryUpdate struct.
GrantAccessData data used for requesting a SAS.
type GrantAccessData struct {
// Access - Possible values include: 'AccessLevelNone', 'AccessLevelRead', 'AccessLevelWrite'
Access AccessLevel `json:"access,omitempty"`
// DurationInSeconds - Time duration in seconds until the SAS access expires.
DurationInSeconds *int32 `json:"durationInSeconds,omitempty"`
// GetSecureVMGuestStateSAS - Set this flag to true to get additional SAS for VM guest state
GetSecureVMGuestStateSAS *bool `json:"getSecureVMGuestStateSAS,omitempty"`
}
HardwareProfile specifies the hardware settings for the virtual machine.
type HardwareProfile struct {
// VMSize - Specifies the size of the virtual machine. <br><br> The enum data type is currently deprecated and will be removed by December 23rd 2023. <br><br> Recommended way to get the list of available sizes is using these APIs: <br><br> [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). <br><br> The available VM sizes depend on region and availability set. Possible values include: 'VirtualMachineSizeTypesBasicA0', 'VirtualMachineSizeTypesBasicA1', 'VirtualMachineSizeTypesBasicA2', 'VirtualMachineSizeTypesBasicA3', 'VirtualMachineSizeTypesBasicA4', 'VirtualMachineSizeTypesStandardA0', 'VirtualMachineSizeTypesStandardA1', 'VirtualMachineSizeTypesStandardA2', 'VirtualMachineSizeTypesStandardA3', 'VirtualMachineSizeTypesStandardA4', 'VirtualMachineSizeTypesStandardA5', 'VirtualMachineSizeTypesStandardA6', 'VirtualMachineSizeTypesStandardA7', 'VirtualMachineSizeTypesStandardA8', 'VirtualMachineSizeTypesStandardA9', 'VirtualMachineSizeTypesStandardA10', 'VirtualMachineSizeTypesStandardA11', 'VirtualMachineSizeTypesStandardA1V2', 'VirtualMachineSizeTypesStandardA2V2', 'VirtualMachineSizeTypesStandardA4V2', 'VirtualMachineSizeTypesStandardA8V2', 'VirtualMachineSizeTypesStandardA2mV2', 'VirtualMachineSizeTypesStandardA4mV2', 'VirtualMachineSizeTypesStandardA8mV2', 'VirtualMachineSizeTypesStandardB1s', 'VirtualMachineSizeTypesStandardB1ms', 'VirtualMachineSizeTypesStandardB2s', 'VirtualMachineSizeTypesStandardB2ms', 'VirtualMachineSizeTypesStandardB4ms', 'VirtualMachineSizeTypesStandardB8ms', 'VirtualMachineSizeTypesStandardD1', 'VirtualMachineSizeTypesStandardD2', 'VirtualMachineSizeTypesStandardD3', 'VirtualMachineSizeTypesStandardD4', 'VirtualMachineSizeTypesStandardD11', 'VirtualMachineSizeTypesStandardD12', 'VirtualMachineSizeTypesStandardD13', 'VirtualMachineSizeTypesStandardD14', 'VirtualMachineSizeTypesStandardD1V2', 'VirtualMachineSizeTypesStandardD2V2', 'VirtualMachineSizeTypesStandardD3V2', 'VirtualMachineSizeTypesStandardD4V2', 'VirtualMachineSizeTypesStandardD5V2', 'VirtualMachineSizeTypesStandardD2V3', 'VirtualMachineSizeTypesStandardD4V3', 'VirtualMachineSizeTypesStandardD8V3', 'VirtualMachineSizeTypesStandardD16V3', 'VirtualMachineSizeTypesStandardD32V3', 'VirtualMachineSizeTypesStandardD64V3', 'VirtualMachineSizeTypesStandardD2sV3', 'VirtualMachineSizeTypesStandardD4sV3', 'VirtualMachineSizeTypesStandardD8sV3', 'VirtualMachineSizeTypesStandardD16sV3', 'VirtualMachineSizeTypesStandardD32sV3', 'VirtualMachineSizeTypesStandardD64sV3', 'VirtualMachineSizeTypesStandardD11V2', 'VirtualMachineSizeTypesStandardD12V2', 'VirtualMachineSizeTypesStandardD13V2', 'VirtualMachineSizeTypesStandardD14V2', 'VirtualMachineSizeTypesStandardD15V2', 'VirtualMachineSizeTypesStandardDS1', 'VirtualMachineSizeTypesStandardDS2', 'VirtualMachineSizeTypesStandardDS3', 'VirtualMachineSizeTypesStandardDS4', 'VirtualMachineSizeTypesStandardDS11', 'VirtualMachineSizeTypesStandardDS12', 'VirtualMachineSizeTypesStandardDS13', 'VirtualMachineSizeTypesStandardDS14', 'VirtualMachineSizeTypesStandardDS1V2', 'VirtualMachineSizeTypesStandardDS2V2', 'VirtualMachineSizeTypesStandardDS3V2', 'VirtualMachineSizeTypesStandardDS4V2', 'VirtualMachineSizeTypesStandardDS5V2', 'VirtualMachineSizeTypesStandardDS11V2', 'VirtualMachineSizeTypesStandardDS12V2', 'VirtualMachineSizeTypesStandardDS13V2', 'VirtualMachineSizeTypesStandardDS14V2', 'VirtualMachineSizeTypesStandardDS15V2', 'VirtualMachineSizeTypesStandardDS134V2', 'VirtualMachineSizeTypesStandardDS132V2', 'VirtualMachineSizeTypesStandardDS148V2', 'VirtualMachineSizeTypesStandardDS144V2', 'VirtualMachineSizeTypesStandardE2V3', 'VirtualMachineSizeTypesStandardE4V3', 'VirtualMachineSizeTypesStandardE8V3', 'VirtualMachineSizeTypesStandardE16V3', 'VirtualMachineSizeTypesStandardE32V3', 'VirtualMachineSizeTypesStandardE64V3', 'VirtualMachineSizeTypesStandardE2sV3', 'VirtualMachineSizeTypesStandardE4sV3', 'VirtualMachineSizeTypesStandardE8sV3', 'VirtualMachineSizeTypesStandardE16sV3', 'VirtualMachineSizeTypesStandardE32sV3', 'VirtualMachineSizeTypesStandardE64sV3', 'VirtualMachineSizeTypesStandardE3216V3', 'VirtualMachineSizeTypesStandardE328sV3', 'VirtualMachineSizeTypesStandardE6432sV3', 'VirtualMachineSizeTypesStandardE6416sV3', 'VirtualMachineSizeTypesStandardF1', 'VirtualMachineSizeTypesStandardF2', 'VirtualMachineSizeTypesStandardF4', 'VirtualMachineSizeTypesStandardF8', 'VirtualMachineSizeTypesStandardF16', 'VirtualMachineSizeTypesStandardF1s', 'VirtualMachineSizeTypesStandardF2s', 'VirtualMachineSizeTypesStandardF4s', 'VirtualMachineSizeTypesStandardF8s', 'VirtualMachineSizeTypesStandardF16s', 'VirtualMachineSizeTypesStandardF2sV2', 'VirtualMachineSizeTypesStandardF4sV2', 'VirtualMachineSizeTypesStandardF8sV2', 'VirtualMachineSizeTypesStandardF16sV2', 'VirtualMachineSizeTypesStandardF32sV2', 'VirtualMachineSizeTypesStandardF64sV2', 'VirtualMachineSizeTypesStandardF72sV2', 'VirtualMachineSizeTypesStandardG1', 'VirtualMachineSizeTypesStandardG2', 'VirtualMachineSizeTypesStandardG3', 'VirtualMachineSizeTypesStandardG4', 'VirtualMachineSizeTypesStandardG5', 'VirtualMachineSizeTypesStandardGS1', 'VirtualMachineSizeTypesStandardGS2', 'VirtualMachineSizeTypesStandardGS3', 'VirtualMachineSizeTypesStandardGS4', 'VirtualMachineSizeTypesStandardGS5', 'VirtualMachineSizeTypesStandardGS48', 'VirtualMachineSizeTypesStandardGS44', 'VirtualMachineSizeTypesStandardGS516', 'VirtualMachineSizeTypesStandardGS58', 'VirtualMachineSizeTypesStandardH8', 'VirtualMachineSizeTypesStandardH16', 'VirtualMachineSizeTypesStandardH8m', 'VirtualMachineSizeTypesStandardH16m', 'VirtualMachineSizeTypesStandardH16r', 'VirtualMachineSizeTypesStandardH16mr', 'VirtualMachineSizeTypesStandardL4s', 'VirtualMachineSizeTypesStandardL8s', 'VirtualMachineSizeTypesStandardL16s', 'VirtualMachineSizeTypesStandardL32s', 'VirtualMachineSizeTypesStandardM64s', 'VirtualMachineSizeTypesStandardM64ms', 'VirtualMachineSizeTypesStandardM128s', 'VirtualMachineSizeTypesStandardM128ms', 'VirtualMachineSizeTypesStandardM6432ms', 'VirtualMachineSizeTypesStandardM6416ms', 'VirtualMachineSizeTypesStandardM12864ms', 'VirtualMachineSizeTypesStandardM12832ms', 'VirtualMachineSizeTypesStandardNC6', 'VirtualMachineSizeTypesStandardNC12', 'VirtualMachineSizeTypesStandardNC24', 'VirtualMachineSizeTypesStandardNC24r', 'VirtualMachineSizeTypesStandardNC6sV2', 'VirtualMachineSizeTypesStandardNC12sV2', 'VirtualMachineSizeTypesStandardNC24sV2', 'VirtualMachineSizeTypesStandardNC24rsV2', 'VirtualMachineSizeTypesStandardNC6sV3', 'VirtualMachineSizeTypesStandardNC12sV3', 'VirtualMachineSizeTypesStandardNC24sV3', 'VirtualMachineSizeTypesStandardNC24rsV3', 'VirtualMachineSizeTypesStandardND6s', 'VirtualMachineSizeTypesStandardND12s', 'VirtualMachineSizeTypesStandardND24s', 'VirtualMachineSizeTypesStandardND24rs', 'VirtualMachineSizeTypesStandardNV6', 'VirtualMachineSizeTypesStandardNV12', 'VirtualMachineSizeTypesStandardNV24'
VMSize VirtualMachineSizeTypes `json:"vmSize,omitempty"`
// VMSizeProperties - Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details.
VMSizeProperties *VMSizeProperties `json:"vmSizeProperties,omitempty"`
}
HostCaching enumerates the values for host caching.
type HostCaching string
const (
// HostCachingNone ...
HostCachingNone HostCaching = "None"
// HostCachingReadOnly ...
HostCachingReadOnly HostCaching = "ReadOnly"
// HostCachingReadWrite ...
HostCachingReadWrite HostCaching = "ReadWrite"
)
func PossibleHostCachingValues() []HostCaching
PossibleHostCachingValues returns an array of possible values for the HostCaching const type.
HyperVGeneration enumerates the values for hyper v generation.
type HyperVGeneration string
const (
// HyperVGenerationV1 ...
HyperVGenerationV1 HyperVGeneration = "V1"
// HyperVGenerationV2 ...
HyperVGenerationV2 HyperVGeneration = "V2"
)
func PossibleHyperVGenerationValues() []HyperVGeneration
PossibleHyperVGenerationValues returns an array of possible values for the HyperVGeneration const type.
HyperVGenerationType enumerates the values for hyper v generation type.
type HyperVGenerationType string
const (
// HyperVGenerationTypeV1 ...
HyperVGenerationTypeV1 HyperVGenerationType = "V1"
// HyperVGenerationTypeV2 ...
HyperVGenerationTypeV2 HyperVGenerationType = "V2"
)
func PossibleHyperVGenerationTypeValues() []HyperVGenerationType
PossibleHyperVGenerationTypeValues returns an array of possible values for the HyperVGenerationType const type.
HyperVGenerationTypes enumerates the values for hyper v generation types.
type HyperVGenerationTypes string
const (
// HyperVGenerationTypesV1 ...
HyperVGenerationTypesV1 HyperVGenerationTypes = "V1"
// HyperVGenerationTypesV2 ...
HyperVGenerationTypesV2 HyperVGenerationTypes = "V2"
)
func PossibleHyperVGenerationTypesValues() []HyperVGenerationTypes
PossibleHyperVGenerationTypesValues returns an array of possible values for the HyperVGenerationTypes const type.
IPVersion enumerates the values for ip version.
type IPVersion string
const (
// IPVersionIPv4 ...
IPVersionIPv4 IPVersion = "IPv4"
// IPVersionIPv6 ...
IPVersionIPv6 IPVersion = "IPv6"
)
func PossibleIPVersionValues() []IPVersion
PossibleIPVersionValues returns an array of possible values for the IPVersion const type.
IPVersions enumerates the values for ip versions.
type IPVersions string
const (
// IPVersionsIPv4 ...
IPVersionsIPv4 IPVersions = "IPv4"
// IPVersionsIPv6 ...
IPVersionsIPv6 IPVersions = "IPv6"
)
func PossibleIPVersionsValues() []IPVersions
PossibleIPVersionsValues returns an array of possible values for the IPVersions const type.
Image the source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
type Image struct {
autorest.Response `json:"-"`
*ImageProperties `json:"properties,omitempty"`
// ExtendedLocation - The extended location of the Image.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (i Image) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Image.
func (i *Image) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Image struct.
ImageDataDisk describes a data disk.
type ImageDataDisk struct {
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Snapshot - The snapshot.
Snapshot *SubResource `json:"snapshot,omitempty"`
// ManagedDisk - The managedDisk.
ManagedDisk *SubResource `json:"managedDisk,omitempty"`
// BlobURI - The Virtual Hard Disk.
BlobURI *string `json:"blobUri,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS', 'StorageAccountTypesPremiumZRS', 'StorageAccountTypesStandardSSDZRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
}
ImageDisk describes a image disk.
type ImageDisk struct {
// Snapshot - The snapshot.
Snapshot *SubResource `json:"snapshot,omitempty"`
// ManagedDisk - The managedDisk.
ManagedDisk *SubResource `json:"managedDisk,omitempty"`
// BlobURI - The Virtual Hard Disk.
BlobURI *string `json:"blobUri,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS', 'StorageAccountTypesPremiumZRS', 'StorageAccountTypesStandardSSDZRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
}
ImageDiskReference the source image used for creating the disk.
type ImageDiskReference struct {
// ID - A relative uri containing either a Platform Image Repository or user image reference.
ID *string `json:"id,omitempty"`
// Lun - If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
Lun *int32 `json:"lun,omitempty"`
}
ImageListResult the List Image operation response.
type ImageListResult struct {
autorest.Response `json:"-"`
// Value - The list of Images.
Value *[]Image `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.
NextLink *string `json:"nextLink,omitempty"`
}
func (ilr ImageListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ImageListResultIterator provides access to a complete listing of Image values.
type ImageListResultIterator struct {
// contains filtered or unexported fields
}
func NewImageListResultIterator(page ImageListResultPage) ImageListResultIterator
Creates a new instance of the ImageListResultIterator type.
func (iter *ImageListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ImageListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ImageListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ImageListResultIterator) Response() ImageListResult
Response returns the raw server response from the last page request.
func (iter ImageListResultIterator) Value() Image
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ImageListResultPage contains a page of Image values.
type ImageListResultPage struct {
// contains filtered or unexported fields
}
func NewImageListResultPage(cur ImageListResult, getNextPage func(context.Context, ImageListResult) (ImageListResult, error)) ImageListResultPage
Creates a new instance of the ImageListResultPage type.
func (page *ImageListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ImageListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ImageListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ImageListResultPage) Response() ImageListResult
Response returns the raw server response from the last page request.
func (page ImageListResultPage) Values() []Image
Values returns the slice of values for the current page or nil if there are no values.
ImageOSDisk describes an Operating System disk.
type ImageOSDisk struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - The OS State. Possible values include: 'OperatingSystemStateTypesGeneralized', 'OperatingSystemStateTypesSpecialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// Snapshot - The snapshot.
Snapshot *SubResource `json:"snapshot,omitempty"`
// ManagedDisk - The managedDisk.
ManagedDisk *SubResource `json:"managedDisk,omitempty"`
// BlobURI - The Virtual Hard Disk.
BlobURI *string `json:"blobUri,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS', 'StorageAccountTypesPremiumZRS', 'StorageAccountTypesStandardSSDZRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed image disk.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
}
ImageProperties describes the properties of an Image.
type ImageProperties struct {
// SourceVirtualMachine - The source virtual machine from which Image is created.
SourceVirtualMachine *SubResource `json:"sourceVirtualMachine,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *ImageStorageProfile `json:"storageProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// HyperVGeneration - Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. Possible values include: 'HyperVGenerationTypesV1', 'HyperVGenerationTypesV2'
HyperVGeneration HyperVGenerationTypes `json:"hyperVGeneration,omitempty"`
}
func (IP ImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageProperties.
ImagePurchasePlan describes the gallery image definition purchase plan. This is used by marketplace images.
type ImagePurchasePlan struct {
// Name - The plan ID.
Name *string `json:"name,omitempty"`
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Product - The product ID.
Product *string `json:"product,omitempty"`
}
ImageReference specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
type ImageReference struct {
// Publisher - The image publisher.
Publisher *string `json:"publisher,omitempty"`
// Offer - Specifies the offer of the platform image or marketplace image used to create the virtual machine.
Offer *string `json:"offer,omitempty"`
// Sku - The image SKU.
Sku *string `json:"sku,omitempty"`
// Version - Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input.
Version *string `json:"version,omitempty"`
// ExactVersion - READ-ONLY; Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
ExactVersion *string `json:"exactVersion,omitempty"`
// SharedGalleryImageID - Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
SharedGalleryImageID *string `json:"sharedGalleryImageId,omitempty"`
// CommunityGalleryImageID - Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
CommunityGalleryImageID *string `json:"communityGalleryImageId,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (ir ImageReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageReference.
ImageStorageProfile describes a storage profile.
type ImageStorageProfile struct {
// OsDisk - Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
OsDisk *ImageOSDisk `json:"osDisk,omitempty"`
// DataDisks - Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
DataDisks *[]ImageDataDisk `json:"dataDisks,omitempty"`
// ZoneResilient - Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
ZoneResilient *bool `json:"zoneResilient,omitempty"`
}
ImageUpdate the source user image virtual hard disk. Only tags may be updated.
type ImageUpdate struct {
*ImageProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (iu ImageUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageUpdate.
func (iu *ImageUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ImageUpdate struct.
ImagesClient is the compute Client
type ImagesClient struct {
BaseClient
}
func NewImagesClient(subscriptionID string) ImagesClient
NewImagesClient creates an instance of the ImagesClient client.
func NewImagesClientWithBaseURI(baseURI string, subscriptionID string) ImagesClient
NewImagesClientWithBaseURI creates an instance of the ImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ImagesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, imageName string, parameters Image) (result ImagesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. parameters - parameters supplied to the Create Image operation.
func (client ImagesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, imageName string, parameters Image) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ImagesClient) CreateOrUpdateResponder(resp *http.Response) (result Image, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ImagesClient) CreateOrUpdateSender(req *http.Request) (future ImagesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Delete(ctx context.Context, resourceGroupName string, imageName string) (result ImagesDeleteFuture, err error)
Delete deletes an Image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image.
func (client ImagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, imageName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ImagesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ImagesClient) DeleteSender(req *http.Request) (future ImagesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Get(ctx context.Context, resourceGroupName string, imageName string, expand string) (result Image, err error)
Get gets an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. expand - the expand expression to apply on the operation.
func (client ImagesClient) GetPreparer(ctx context.Context, resourceGroupName string, imageName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ImagesClient) GetResponder(resp *http.Response) (result Image, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) List(ctx context.Context) (result ImageListResultPage, err error)
List gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
func (client ImagesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ImageListResultPage, err error)
ListByResourceGroup gets the list of images under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ImagesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ImageListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ImagesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ImagesClient) ListByResourceGroupResponder(resp *http.Response) (result ImageListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ImagesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) ListComplete(ctx context.Context) (result ImageListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ImagesClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client ImagesClient) ListResponder(resp *http.Response) (result ImageListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Update(ctx context.Context, resourceGroupName string, imageName string, parameters ImageUpdate) (result ImagesUpdateFuture, err error)
Update update an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. parameters - parameters supplied to the Update Image operation.
func (client ImagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, imageName string, parameters ImageUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ImagesClient) UpdateResponder(resp *http.Response) (result Image, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ImagesClient) UpdateSender(req *http.Request) (future ImagesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (Image, error)
}
func (future *ImagesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (autorest.Response, error)
}
func (future *ImagesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ImagesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (Image, error)
}
func (future *ImagesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
InnerError inner error details.
type InnerError struct {
// Exceptiontype - The exception type.
Exceptiontype *string `json:"exceptiontype,omitempty"`
// Errordetail - The internal error message or exception dump.
Errordetail *string `json:"errordetail,omitempty"`
}
InstanceSku ...
type InstanceSku struct {
// Name - READ-ONLY; The sku name.
Name *string `json:"name,omitempty"`
// Tier - READ-ONLY; The tier of the cloud service role instance.
Tier *string `json:"tier,omitempty"`
}
func (is InstanceSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InstanceSku.
InstanceViewStatus instance view status.
type InstanceViewStatus struct {
// Code - The status code.
Code *string `json:"code,omitempty"`
// Level - The level code. Possible values include: 'StatusLevelTypesInfo', 'StatusLevelTypesWarning', 'StatusLevelTypesError'
Level StatusLevelTypes `json:"level,omitempty"`
// DisplayStatus - The short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - The detailed status message, including for alerts and error messages.
Message *string `json:"message,omitempty"`
// Time - The time of the status.
Time *date.Time `json:"time,omitempty"`
}
InstanceViewStatusesSummary instance view statuses.
type InstanceViewStatusesSummary struct {
// StatusesSummary - READ-ONLY
StatusesSummary *[]StatusCodeCount `json:"statusesSummary,omitempty"`
}
func (ivss InstanceViewStatusesSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InstanceViewStatusesSummary.
InstanceViewTypes enumerates the values for instance view types.
type InstanceViewTypes string
const (
// InstanceViewTypesInstanceView ...
InstanceViewTypesInstanceView InstanceViewTypes = "instanceView"
// InstanceViewTypesUserData ...
InstanceViewTypesUserData InstanceViewTypes = "userData"
)
func PossibleInstanceViewTypesValues() []InstanceViewTypes
PossibleInstanceViewTypesValues returns an array of possible values for the InstanceViewTypes const type.
IntervalInMins enumerates the values for interval in mins.
type IntervalInMins string
const (
// IntervalInMinsFiveMins ...
IntervalInMinsFiveMins IntervalInMins = "FiveMins"
// IntervalInMinsSixtyMins ...
IntervalInMinsSixtyMins IntervalInMins = "SixtyMins"
// IntervalInMinsThirtyMins ...
IntervalInMinsThirtyMins IntervalInMins = "ThirtyMins"
// IntervalInMinsThreeMins ...
IntervalInMinsThreeMins IntervalInMins = "ThreeMins"
)
func PossibleIntervalInMinsValues() []IntervalInMins
PossibleIntervalInMinsValues returns an array of possible values for the IntervalInMins const type.
KeyForDiskEncryptionSet key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots
type KeyForDiskEncryptionSet struct {
// SourceVault - Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.
SourceVault *SourceVault `json:"sourceVault,omitempty"`
// KeyURL - Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
KeyURL *string `json:"keyUrl,omitempty"`
}
KeyVaultAndKeyReference key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
type KeyVaultAndKeyReference struct {
// SourceVault - Resource id of the KeyVault containing the key or secret
SourceVault *SourceVault `json:"sourceVault,omitempty"`
// KeyURL - Url pointing to a key or secret in KeyVault
KeyURL *string `json:"keyUrl,omitempty"`
}
KeyVaultAndSecretReference key Vault Secret Url and vault id of the encryption key
type KeyVaultAndSecretReference struct {
// SourceVault - Resource id of the KeyVault containing the key or secret
SourceVault *SourceVault `json:"sourceVault,omitempty"`
// SecretURL - Url pointing to a key or secret in KeyVault
SecretURL *string `json:"secretUrl,omitempty"`
}
KeyVaultKeyReference describes a reference to Key Vault Key
type KeyVaultKeyReference struct {
// KeyURL - The URL referencing a key encryption key in Key Vault.
KeyURL *string `json:"keyUrl,omitempty"`
// SourceVault - The relative URL of the Key Vault containing the key.
SourceVault *SubResource `json:"sourceVault,omitempty"`
}
KeyVaultSecretReference describes a reference to Key Vault Secret
type KeyVaultSecretReference struct {
// SecretURL - The URL referencing a secret in a Key Vault.
SecretURL *string `json:"secretUrl,omitempty"`
// SourceVault - The relative URL of the Key Vault containing the secret.
SourceVault *SubResource `json:"sourceVault,omitempty"`
}
LastPatchInstallationSummary describes the properties of the last installed patch summary.
type LastPatchInstallationSummary struct {
// Status - READ-ONLY; The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings.". Possible values include: 'PatchOperationStatusUnknown', 'PatchOperationStatusInProgress', 'PatchOperationStatusFailed', 'PatchOperationStatusSucceeded', 'PatchOperationStatusCompletedWithWarnings'
Status PatchOperationStatus `json:"status,omitempty"`
// InstallationActivityID - READ-ONLY; The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
InstallationActivityID *string `json:"installationActivityId,omitempty"`
// MaintenanceWindowExceeded - READ-ONLY; Describes whether the operation ran out of time before it completed all its intended actions
MaintenanceWindowExceeded *bool `json:"maintenanceWindowExceeded,omitempty"`
// NotSelectedPatchCount - READ-ONLY; The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry.
NotSelectedPatchCount *int32 `json:"notSelectedPatchCount,omitempty"`
// ExcludedPatchCount - READ-ONLY; The number of all available patches but excluded explicitly by a customer-specified exclusion list match.
ExcludedPatchCount *int32 `json:"excludedPatchCount,omitempty"`
// PendingPatchCount - READ-ONLY; The number of all available patches expected to be installed over the course of the patch installation operation.
PendingPatchCount *int32 `json:"pendingPatchCount,omitempty"`
// InstalledPatchCount - READ-ONLY; The count of patches that successfully installed.
InstalledPatchCount *int32 `json:"installedPatchCount,omitempty"`
// FailedPatchCount - READ-ONLY; The count of patches that failed installation.
FailedPatchCount *int32 `json:"failedPatchCount,omitempty"`
// StartTime - READ-ONLY; The UTC timestamp when the operation began.
StartTime *date.Time `json:"startTime,omitempty"`
// LastModifiedTime - READ-ONLY; The UTC timestamp when the operation began.
LastModifiedTime *date.Time `json:"lastModifiedTime,omitempty"`
// Error - READ-ONLY; The errors that were encountered during execution of the operation. The details array contains the list of them.
Error *APIError `json:"error,omitempty"`
}
func (lpis LastPatchInstallationSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LastPatchInstallationSummary.
LinuxConfiguration specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
type LinuxConfiguration struct {
// DisablePasswordAuthentication - Specifies whether password authentication should be disabled.
DisablePasswordAuthentication *bool `json:"disablePasswordAuthentication,omitempty"`
// SSH - Specifies the ssh key configuration for a Linux OS.
SSH *SSHConfiguration `json:"ssh,omitempty"`
// ProvisionVMAgent - Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ProvisionVMAgent *bool `json:"provisionVMAgent,omitempty"`
// PatchSettings - [Preview Feature] Specifies settings related to VM Guest Patching on Linux.
PatchSettings *LinuxPatchSettings `json:"patchSettings,omitempty"`
}
LinuxParameters input for InstallPatches on a Linux VM, as directly received by the API
type LinuxParameters struct {
// ClassificationsToInclude - The update classifications to select when installing patches for Linux.
ClassificationsToInclude *[]VMGuestPatchClassificationLinux `json:"classificationsToInclude,omitempty"`
// PackageNameMasksToInclude - packages to include in the patch operation. Format: packageName_packageVersion
PackageNameMasksToInclude *[]string `json:"packageNameMasksToInclude,omitempty"`
// PackageNameMasksToExclude - packages to exclude in the patch operation. Format: packageName_packageVersion
PackageNameMasksToExclude *[]string `json:"packageNameMasksToExclude,omitempty"`
// MaintenanceRunID - This is used as a maintenance run identifier for Auto VM Guest Patching in Linux.
MaintenanceRunID *string `json:"maintenanceRunId,omitempty"`
}
LinuxPatchAssessmentMode enumerates the values for linux patch assessment mode.
type LinuxPatchAssessmentMode string
const (
// LinuxPatchAssessmentModeAutomaticByPlatform ...
LinuxPatchAssessmentModeAutomaticByPlatform LinuxPatchAssessmentMode = "AutomaticByPlatform"
// LinuxPatchAssessmentModeImageDefault ...
LinuxPatchAssessmentModeImageDefault LinuxPatchAssessmentMode = "ImageDefault"
)
func PossibleLinuxPatchAssessmentModeValues() []LinuxPatchAssessmentMode
PossibleLinuxPatchAssessmentModeValues returns an array of possible values for the LinuxPatchAssessmentMode const type.
LinuxPatchSettings specifies settings related to VM Guest Patching on Linux.
type LinuxPatchSettings struct {
// PatchMode - Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The virtual machine's default patching configuration is used. <br /><br /> **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true. Possible values include: 'LinuxVMGuestPatchModeImageDefault', 'LinuxVMGuestPatchModeAutomaticByPlatform'
PatchMode LinuxVMGuestPatchMode `json:"patchMode,omitempty"`
// AssessmentMode - Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine. <br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. Possible values include: 'LinuxPatchAssessmentModeImageDefault', 'LinuxPatchAssessmentModeAutomaticByPlatform'
AssessmentMode LinuxPatchAssessmentMode `json:"assessmentMode,omitempty"`
}
LinuxVMGuestPatchMode enumerates the values for linux vm guest patch mode.
type LinuxVMGuestPatchMode string
const (
// LinuxVMGuestPatchModeAutomaticByPlatform ...
LinuxVMGuestPatchModeAutomaticByPlatform LinuxVMGuestPatchMode = "AutomaticByPlatform"
// LinuxVMGuestPatchModeImageDefault ...
LinuxVMGuestPatchModeImageDefault LinuxVMGuestPatchMode = "ImageDefault"
)
func PossibleLinuxVMGuestPatchModeValues() []LinuxVMGuestPatchMode
PossibleLinuxVMGuestPatchModeValues returns an array of possible values for the LinuxVMGuestPatchMode const type.
ListUsagesResult the List Usages operation response.
type ListUsagesResult struct {
autorest.Response `json:"-"`
// Value - The list of compute resource usages.
Value *[]Usage `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.
NextLink *string `json:"nextLink,omitempty"`
}
func (lur ListUsagesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListUsagesResultIterator provides access to a complete listing of Usage values.
type ListUsagesResultIterator struct {
// contains filtered or unexported fields
}
func NewListUsagesResultIterator(page ListUsagesResultPage) ListUsagesResultIterator
Creates a new instance of the ListUsagesResultIterator type.
func (iter *ListUsagesResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListUsagesResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListUsagesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListUsagesResultIterator) Response() ListUsagesResult
Response returns the raw server response from the last page request.
func (iter ListUsagesResultIterator) Value() Usage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListUsagesResultPage contains a page of Usage values.
type ListUsagesResultPage struct {
// contains filtered or unexported fields
}
func NewListUsagesResultPage(cur ListUsagesResult, getNextPage func(context.Context, ListUsagesResult) (ListUsagesResult, error)) ListUsagesResultPage
Creates a new instance of the ListUsagesResultPage type.
func (page *ListUsagesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListUsagesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListUsagesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListUsagesResultPage) Response() ListUsagesResult
Response returns the raw server response from the last page request.
func (page ListUsagesResultPage) Values() []Usage
Values returns the slice of values for the current page or nil if there are no values.
ListVirtualMachineExtensionImage ...
type ListVirtualMachineExtensionImage struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineExtensionImage `json:"value,omitempty"`
}
ListVirtualMachineImageResource ...
type ListVirtualMachineImageResource struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineImageResource `json:"value,omitempty"`
}
LoadBalancerConfiguration describes the load balancer configuration.
type LoadBalancerConfiguration struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
// Name - The name of the Load balancer
Name *string `json:"name,omitempty"`
// Properties - Properties of the load balancer configuration.
Properties *LoadBalancerConfigurationProperties `json:"properties,omitempty"`
}
LoadBalancerConfigurationProperties ...
type LoadBalancerConfigurationProperties struct {
// FrontendIPConfigurations - Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.
FrontendIPConfigurations *[]LoadBalancerFrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`
}
LoadBalancerFrontendIPConfiguration ...
type LoadBalancerFrontendIPConfiguration struct {
// Name - The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.
Name *string `json:"name,omitempty"`
// Properties - Properties of load balancer frontend ip configuration.
Properties *LoadBalancerFrontendIPConfigurationProperties `json:"properties,omitempty"`
}
LoadBalancerFrontendIPConfigurationProperties describes a cloud service IP Configuration
type LoadBalancerFrontendIPConfigurationProperties struct {
// PublicIPAddress - The reference to the public ip address resource.
PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`
// Subnet - The reference to the virtual network subnet resource.
Subnet *SubResource `json:"subnet,omitempty"`
// PrivateIPAddress - The virtual network private IP address of the IP configuration.
PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
}
LogAnalyticsClient is the compute Client
type LogAnalyticsClient struct {
BaseClient
}
func NewLogAnalyticsClient(subscriptionID string) LogAnalyticsClient
NewLogAnalyticsClient creates an instance of the LogAnalyticsClient client.
func NewLogAnalyticsClientWithBaseURI(baseURI string, subscriptionID string) LogAnalyticsClient
NewLogAnalyticsClientWithBaseURI creates an instance of the LogAnalyticsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client LogAnalyticsClient) ExportRequestRateByInterval(ctx context.Context, parameters RequestRateByIntervalInput, location string) (result LogAnalyticsExportRequestRateByIntervalFuture, err error)
ExportRequestRateByInterval export logs that show Api requests made by this subscription in the given time window to show throttling activities. Parameters: parameters - parameters supplied to the LogAnalytics getRequestRateByInterval Api. location - the location upon which virtual-machine-sizes is queried.
func (client LogAnalyticsClient) ExportRequestRateByIntervalPreparer(ctx context.Context, parameters RequestRateByIntervalInput, location string) (*http.Request, error)
ExportRequestRateByIntervalPreparer prepares the ExportRequestRateByInterval request.
func (client LogAnalyticsClient) ExportRequestRateByIntervalResponder(resp *http.Response) (result LogAnalyticsOperationResult, err error)
ExportRequestRateByIntervalResponder handles the response to the ExportRequestRateByInterval request. The method always closes the http.Response Body.
func (client LogAnalyticsClient) ExportRequestRateByIntervalSender(req *http.Request) (future LogAnalyticsExportRequestRateByIntervalFuture, err error)
ExportRequestRateByIntervalSender sends the ExportRequestRateByInterval request. The method will close the http.Response Body if it receives an error.
func (client LogAnalyticsClient) ExportThrottledRequests(ctx context.Context, parameters ThrottledRequestsInput, location string) (result LogAnalyticsExportThrottledRequestsFuture, err error)
ExportThrottledRequests export logs that show total throttled Api requests for this subscription in the given time window. Parameters: parameters - parameters supplied to the LogAnalytics getThrottledRequests Api. location - the location upon which virtual-machine-sizes is queried.
func (client LogAnalyticsClient) ExportThrottledRequestsPreparer(ctx context.Context, parameters ThrottledRequestsInput, location string) (*http.Request, error)
ExportThrottledRequestsPreparer prepares the ExportThrottledRequests request.
func (client LogAnalyticsClient) ExportThrottledRequestsResponder(resp *http.Response) (result LogAnalyticsOperationResult, err error)
ExportThrottledRequestsResponder handles the response to the ExportThrottledRequests request. The method always closes the http.Response Body.
func (client LogAnalyticsClient) ExportThrottledRequestsSender(req *http.Request) (future LogAnalyticsExportThrottledRequestsFuture, err error)
ExportThrottledRequestsSender sends the ExportThrottledRequests request. The method will close the http.Response Body if it receives an error.
LogAnalyticsExportRequestRateByIntervalFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LogAnalyticsExportRequestRateByIntervalFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LogAnalyticsClient) (LogAnalyticsOperationResult, error)
}
func (future *LogAnalyticsExportRequestRateByIntervalFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LogAnalyticsExportThrottledRequestsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LogAnalyticsExportThrottledRequestsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LogAnalyticsClient) (LogAnalyticsOperationResult, error)
}
func (future *LogAnalyticsExportThrottledRequestsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LogAnalyticsInputBase api input base class for LogAnalytics Api.
type LogAnalyticsInputBase struct {
// BlobContainerSasURI - SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
BlobContainerSasURI *string `json:"blobContainerSasUri,omitempty"`
// FromTime - From time of the query
FromTime *date.Time `json:"fromTime,omitempty"`
// ToTime - To time of the query
ToTime *date.Time `json:"toTime,omitempty"`
// GroupByThrottlePolicy - Group query result by Throttle Policy applied.
GroupByThrottlePolicy *bool `json:"groupByThrottlePolicy,omitempty"`
// GroupByOperationName - Group query result by Operation Name.
GroupByOperationName *bool `json:"groupByOperationName,omitempty"`
// GroupByResourceName - Group query result by Resource Name.
GroupByResourceName *bool `json:"groupByResourceName,omitempty"`
// GroupByClientApplicationID - Group query result by Client Application ID.
GroupByClientApplicationID *bool `json:"groupByClientApplicationId,omitempty"`
// GroupByUserAgent - Group query result by User Agent.
GroupByUserAgent *bool `json:"groupByUserAgent,omitempty"`
}
LogAnalyticsOperationResult logAnalytics operation status response
type LogAnalyticsOperationResult struct {
autorest.Response `json:"-"`
// Properties - READ-ONLY; LogAnalyticsOutput
Properties *LogAnalyticsOutput `json:"properties,omitempty"`
}
func (laor LogAnalyticsOperationResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LogAnalyticsOperationResult.
LogAnalyticsOutput logAnalytics output properties
type LogAnalyticsOutput struct {
// Output - READ-ONLY; Output file Uri path to blob container.
Output *string `json:"output,omitempty"`
}
func (lao LogAnalyticsOutput) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LogAnalyticsOutput.
MaintenanceOperationResultCodeTypes enumerates the values for maintenance operation result code types.
type MaintenanceOperationResultCodeTypes string
const (
// MaintenanceOperationResultCodeTypesMaintenanceAborted ...
MaintenanceOperationResultCodeTypesMaintenanceAborted MaintenanceOperationResultCodeTypes = "MaintenanceAborted"
// MaintenanceOperationResultCodeTypesMaintenanceCompleted ...
MaintenanceOperationResultCodeTypesMaintenanceCompleted MaintenanceOperationResultCodeTypes = "MaintenanceCompleted"
// MaintenanceOperationResultCodeTypesNone ...
MaintenanceOperationResultCodeTypesNone MaintenanceOperationResultCodeTypes = "None"
// MaintenanceOperationResultCodeTypesRetryLater ...
MaintenanceOperationResultCodeTypesRetryLater MaintenanceOperationResultCodeTypes = "RetryLater"
)
func PossibleMaintenanceOperationResultCodeTypesValues() []MaintenanceOperationResultCodeTypes
PossibleMaintenanceOperationResultCodeTypesValues returns an array of possible values for the MaintenanceOperationResultCodeTypes const type.
MaintenanceRedeployStatus maintenance Operation Status.
type MaintenanceRedeployStatus struct {
// IsCustomerInitiatedMaintenanceAllowed - True, if customer is allowed to perform Maintenance.
IsCustomerInitiatedMaintenanceAllowed *bool `json:"isCustomerInitiatedMaintenanceAllowed,omitempty"`
// PreMaintenanceWindowStartTime - Start Time for the Pre Maintenance Window.
PreMaintenanceWindowStartTime *date.Time `json:"preMaintenanceWindowStartTime,omitempty"`
// PreMaintenanceWindowEndTime - End Time for the Pre Maintenance Window.
PreMaintenanceWindowEndTime *date.Time `json:"preMaintenanceWindowEndTime,omitempty"`
// MaintenanceWindowStartTime - Start Time for the Maintenance Window.
MaintenanceWindowStartTime *date.Time `json:"maintenanceWindowStartTime,omitempty"`
// MaintenanceWindowEndTime - End Time for the Maintenance Window.
MaintenanceWindowEndTime *date.Time `json:"maintenanceWindowEndTime,omitempty"`
// LastOperationResultCode - The Last Maintenance Operation Result Code. Possible values include: 'MaintenanceOperationResultCodeTypesNone', 'MaintenanceOperationResultCodeTypesRetryLater', 'MaintenanceOperationResultCodeTypesMaintenanceAborted', 'MaintenanceOperationResultCodeTypesMaintenanceCompleted'
LastOperationResultCode MaintenanceOperationResultCodeTypes `json:"lastOperationResultCode,omitempty"`
// LastOperationMessage - Message returned for the last Maintenance Operation.
LastOperationMessage *string `json:"lastOperationMessage,omitempty"`
}
ManagedArtifact the managed artifact.
type ManagedArtifact struct {
// ID - The managed artifact id.
ID *string `json:"id,omitempty"`
}
ManagedDiskParameters the parameters of a managed disk.
type ManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS', 'StorageAccountTypesPremiumZRS', 'StorageAccountTypesStandardSSDZRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed disk.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
// SecurityProfile - Specifies the security profile for the managed disk.
SecurityProfile *VMDiskSecurityProfile `json:"securityProfile,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
NetworkAPIVersion enumerates the values for network api version.
type NetworkAPIVersion string
const (
// NetworkAPIVersionTwoZeroTwoZeroHyphenMinusOneOneHyphenMinusZeroOne ...
NetworkAPIVersionTwoZeroTwoZeroHyphenMinusOneOneHyphenMinusZeroOne NetworkAPIVersion = "2020-11-01"
)
func PossibleNetworkAPIVersionValues() []NetworkAPIVersion
PossibleNetworkAPIVersionValues returns an array of possible values for the NetworkAPIVersion const type.
NetworkAccessPolicy enumerates the values for network access policy.
type NetworkAccessPolicy string
const (
// NetworkAccessPolicyAllowAll The disk can be exported or uploaded to from any network.
NetworkAccessPolicyAllowAll NetworkAccessPolicy = "AllowAll"
// NetworkAccessPolicyAllowPrivate The disk can be exported or uploaded to using a DiskAccess resource's
// private endpoints.
NetworkAccessPolicyAllowPrivate NetworkAccessPolicy = "AllowPrivate"
// NetworkAccessPolicyDenyAll The disk cannot be exported.
NetworkAccessPolicyDenyAll NetworkAccessPolicy = "DenyAll"
)
func PossibleNetworkAccessPolicyValues() []NetworkAccessPolicy
PossibleNetworkAccessPolicyValues returns an array of possible values for the NetworkAccessPolicy const type.
NetworkInterfaceReference describes a network interface reference.
type NetworkInterfaceReference struct {
*NetworkInterfaceReferenceProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (nir NetworkInterfaceReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NetworkInterfaceReference.
func (nir *NetworkInterfaceReference) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NetworkInterfaceReference struct.
NetworkInterfaceReferenceProperties describes a network interface reference properties.
type NetworkInterfaceReferenceProperties struct {
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// DeleteOption - Specify what happens to the network interface when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
}
NetworkProfile specifies the network interfaces or the networking configuration of the virtual machine.
type NetworkProfile struct {
// NetworkInterfaces - Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
NetworkInterfaces *[]NetworkInterfaceReference `json:"networkInterfaces,omitempty"`
// NetworkAPIVersion - specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations. Possible values include: 'NetworkAPIVersionTwoZeroTwoZeroHyphenMinusOneOneHyphenMinusZeroOne'
NetworkAPIVersion NetworkAPIVersion `json:"networkApiVersion,omitempty"`
// NetworkInterfaceConfigurations - Specifies the networking configurations that will be used to create the virtual machine networking resources.
NetworkInterfaceConfigurations *[]VirtualMachineNetworkInterfaceConfiguration `json:"networkInterfaceConfigurations,omitempty"`
}
OSDisk specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
type OSDisk struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// EncryptionSettings - Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
EncryptionSettings *DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Vhd - The virtual hard disk.
Vhd *VirtualHardDisk `json:"vhd,omitempty"`
// Image - The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None** for Standard storage. **ReadOnly** for Premium storage. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// DiffDiskSettings - Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiffDiskSettings *DiffDiskSettings `json:"diffDiskSettings,omitempty"`
// CreateOption - Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiskSizeGB - Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
// DeleteOption - Specifies whether OS Disk should be deleted or detached upon VM deletion. <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the os disk is retained after VM is deleted. <br><br> The default value is set to **detach**. For an ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for ephemeral OS Disk. Possible values include: 'DiskDeleteOptionTypesDelete', 'DiskDeleteOptionTypesDetach'
DeleteOption DiskDeleteOptionTypes `json:"deleteOption,omitempty"`
}
OSDiskImage contains the os disk image information.
type OSDiskImage struct {
// OperatingSystem - The operating system of the osDiskImage. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OperatingSystem OperatingSystemTypes `json:"operatingSystem,omitempty"`
}
OSDiskImageEncryption contains encryption settings for an OS disk image.
type OSDiskImageEncryption struct {
// SecurityProfile - This property specifies the security profile of an OS disk image.
SecurityProfile *OSDiskImageSecurityProfile `json:"securityProfile,omitempty"`
// DiskEncryptionSetID - A relative URI containing the resource ID of the disk encryption set.
DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"`
}
OSDiskImageSecurityProfile contains security profile for an OS disk image.
type OSDiskImageSecurityProfile struct {
// ConfidentialVMEncryptionType - confidential VM encryption types. Possible values include: 'ConfidentialVMEncryptionTypeEncryptedVMGuestStateOnlyWithPmk', 'ConfidentialVMEncryptionTypeEncryptedWithPmk', 'ConfidentialVMEncryptionTypeEncryptedWithCmk'
ConfidentialVMEncryptionType ConfidentialVMEncryptionType `json:"confidentialVMEncryptionType,omitempty"`
// SecureVMDiskEncryptionSetID - secure VM disk encryption set id
SecureVMDiskEncryptionSetID *string `json:"secureVMDiskEncryptionSetId,omitempty"`
}
OSFamily describes a cloud service OS family.
type OSFamily struct {
autorest.Response `json:"-"`
// 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 - READ-ONLY; Resource location.
Location *string `json:"location,omitempty"`
Properties *OSFamilyProperties `json:"properties,omitempty"`
}
func (of OSFamily) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OSFamily.
OSFamilyListResult ...
type OSFamilyListResult struct {
autorest.Response `json:"-"`
Value *[]OSFamily `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (oflr OSFamilyListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OSFamilyListResultIterator provides access to a complete listing of OSFamily values.
type OSFamilyListResultIterator struct {
// contains filtered or unexported fields
}
func NewOSFamilyListResultIterator(page OSFamilyListResultPage) OSFamilyListResultIterator
Creates a new instance of the OSFamilyListResultIterator type.
func (iter *OSFamilyListResultIterator) 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 *OSFamilyListResultIterator) 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 OSFamilyListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OSFamilyListResultIterator) Response() OSFamilyListResult
Response returns the raw server response from the last page request.
func (iter OSFamilyListResultIterator) Value() OSFamily
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OSFamilyListResultPage contains a page of OSFamily values.
type OSFamilyListResultPage struct {
// contains filtered or unexported fields
}
func NewOSFamilyListResultPage(cur OSFamilyListResult, getNextPage func(context.Context, OSFamilyListResult) (OSFamilyListResult, error)) OSFamilyListResultPage
Creates a new instance of the OSFamilyListResultPage type.
func (page *OSFamilyListResultPage) 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 *OSFamilyListResultPage) 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 OSFamilyListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OSFamilyListResultPage) Response() OSFamilyListResult
Response returns the raw server response from the last page request.
func (page OSFamilyListResultPage) Values() []OSFamily
Values returns the slice of values for the current page or nil if there are no values.
OSFamilyProperties OS family properties.
type OSFamilyProperties struct {
// Name - READ-ONLY; The OS family name.
Name *string `json:"name,omitempty"`
// Label - READ-ONLY; The OS family label.
Label *string `json:"label,omitempty"`
// Versions - READ-ONLY; List of OS versions belonging to this family.
Versions *[]OSVersionPropertiesBase `json:"versions,omitempty"`
}
func (ofp OSFamilyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OSFamilyProperties.
OSProfile specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
type OSProfile struct {
// ComputerName - Specifies the host OS name of the virtual machine. <br><br> This name cannot be updated after the VM is created. <br><br> **Max-length (Windows):** 15 characters <br><br> **Max-length (Linux):** 64 characters. <br><br> For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).
ComputerName *string `json:"computerName,omitempty"`
// AdminUsername - Specifies the name of the administrator account. <br><br> This property cannot be updated after the VM is created. <br><br> **Windows-only restriction:** Cannot end in "." <br><br> **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters.
AdminUsername *string `json:"adminUsername,omitempty"`
// AdminPassword - Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
AdminPassword *string `json:"adminPassword,omitempty"`
// CustomData - Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> **Note: Do not pass any secrets or passwords in customData property** <br><br> This property cannot be updated after the VM is created. <br><br> customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/) <br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)
CustomData *string `json:"customData,omitempty"`
// WindowsConfiguration - Specifies Windows operating system settings on the virtual machine.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// LinuxConfiguration - Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
LinuxConfiguration *LinuxConfiguration `json:"linuxConfiguration,omitempty"`
// Secrets - Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
// AllowExtensionOperations - Specifies whether extension operations should be allowed on the virtual machine. <br><br>This may only be set to False when no extensions are present on the virtual machine.
AllowExtensionOperations *bool `json:"allowExtensionOperations,omitempty"`
// RequireGuestProvisionSignal - Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.**
RequireGuestProvisionSignal *bool `json:"requireGuestProvisionSignal,omitempty"`
}
OSVersion describes a cloud service OS version.
type OSVersion struct {
autorest.Response `json:"-"`
// 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 - READ-ONLY; Resource location.
Location *string `json:"location,omitempty"`
Properties *OSVersionProperties `json:"properties,omitempty"`
}
func (ov OSVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OSVersion.
OSVersionListResult ...
type OSVersionListResult struct {
autorest.Response `json:"-"`
Value *[]OSVersion `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (ovlr OSVersionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OSVersionListResultIterator provides access to a complete listing of OSVersion values.
type OSVersionListResultIterator struct {
// contains filtered or unexported fields
}
func NewOSVersionListResultIterator(page OSVersionListResultPage) OSVersionListResultIterator
Creates a new instance of the OSVersionListResultIterator type.
func (iter *OSVersionListResultIterator) 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 *OSVersionListResultIterator) 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 OSVersionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OSVersionListResultIterator) Response() OSVersionListResult
Response returns the raw server response from the last page request.
func (iter OSVersionListResultIterator) Value() OSVersion
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OSVersionListResultPage contains a page of OSVersion values.
type OSVersionListResultPage struct {
// contains filtered or unexported fields
}
func NewOSVersionListResultPage(cur OSVersionListResult, getNextPage func(context.Context, OSVersionListResult) (OSVersionListResult, error)) OSVersionListResultPage
Creates a new instance of the OSVersionListResultPage type.
func (page *OSVersionListResultPage) 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 *OSVersionListResultPage) 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 OSVersionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OSVersionListResultPage) Response() OSVersionListResult
Response returns the raw server response from the last page request.
func (page OSVersionListResultPage) Values() []OSVersion
Values returns the slice of values for the current page or nil if there are no values.
OSVersionProperties OS version properties.
type OSVersionProperties struct {
// Family - READ-ONLY; The family of this OS version.
Family *string `json:"family,omitempty"`
// FamilyLabel - READ-ONLY; The family label of this OS version.
FamilyLabel *string `json:"familyLabel,omitempty"`
// Version - READ-ONLY; The OS version.
Version *string `json:"version,omitempty"`
// Label - READ-ONLY; The OS version label.
Label *string `json:"label,omitempty"`
// IsDefault - READ-ONLY; Specifies whether this is the default OS version for its family.
IsDefault *bool `json:"isDefault,omitempty"`
// IsActive - READ-ONLY; Specifies whether this OS version is active.
IsActive *bool `json:"isActive,omitempty"`
}
func (ovp OSVersionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OSVersionProperties.
OSVersionPropertiesBase configuration view of an OS version.
type OSVersionPropertiesBase struct {
// Version - READ-ONLY; The OS version.
Version *string `json:"version,omitempty"`
// Label - READ-ONLY; The OS version label.
Label *string `json:"label,omitempty"`
// IsDefault - READ-ONLY; Specifies whether this is the default OS version for its family.
IsDefault *bool `json:"isDefault,omitempty"`
// IsActive - READ-ONLY; Specifies whether this OS version is active.
IsActive *bool `json:"isActive,omitempty"`
}
func (ovpb OSVersionPropertiesBase) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OSVersionPropertiesBase.
OperatingSystemStateTypes enumerates the values for operating system state types.
type OperatingSystemStateTypes string
const (
// OperatingSystemStateTypesGeneralized Generalized image. Needs to be provisioned during deployment time.
OperatingSystemStateTypesGeneralized OperatingSystemStateTypes = "Generalized"
// OperatingSystemStateTypesSpecialized Specialized image. Contains already provisioned OS Disk.
OperatingSystemStateTypesSpecialized OperatingSystemStateTypes = "Specialized"
)
func PossibleOperatingSystemStateTypesValues() []OperatingSystemStateTypes
PossibleOperatingSystemStateTypesValues returns an array of possible values for the OperatingSystemStateTypes const type.
OperatingSystemType enumerates the values for operating system type.
type OperatingSystemType string
const (
// OperatingSystemTypeLinux ...
OperatingSystemTypeLinux OperatingSystemType = "Linux"
// OperatingSystemTypeWindows ...
OperatingSystemTypeWindows OperatingSystemType = "Windows"
)
func PossibleOperatingSystemTypeValues() []OperatingSystemType
PossibleOperatingSystemTypeValues returns an array of possible values for the OperatingSystemType const type.
OperatingSystemTypes enumerates the values for operating system types.
type OperatingSystemTypes string
const (
// OperatingSystemTypesLinux ...
OperatingSystemTypesLinux OperatingSystemTypes = "Linux"
// OperatingSystemTypesWindows ...
OperatingSystemTypesWindows OperatingSystemTypes = "Windows"
)
func PossibleOperatingSystemTypesValues() []OperatingSystemTypes
PossibleOperatingSystemTypesValues returns an array of possible values for the OperatingSystemTypes const type.
OperationListResult the List Compute Operation operation response.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of compute operations
Value *[]OperationValue `json:"value,omitempty"`
}
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
OperationValue describes the properties of a Compute Operation value.
type OperationValue struct {
// Origin - READ-ONLY; The origin of the compute operation.
Origin *string `json:"origin,omitempty"`
// Name - READ-ONLY; The name of the compute operation.
Name *string `json:"name,omitempty"`
*OperationValueDisplay `json:"display,omitempty"`
}
func (ov OperationValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationValue.
func (ov *OperationValue) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationValue struct.
OperationValueDisplay describes the properties of a Compute Operation Value Display.
type OperationValueDisplay struct {
// Operation - READ-ONLY; The display name of the compute operation.
Operation *string `json:"operation,omitempty"`
// Resource - READ-ONLY; The display name of the resource the operation applies to.
Resource *string `json:"resource,omitempty"`
// Description - READ-ONLY; The description of the operation.
Description *string `json:"description,omitempty"`
// Provider - READ-ONLY; The resource provider for the operation.
Provider *string `json:"provider,omitempty"`
}
func (ovd OperationValueDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationValueDisplay.
OperationsClient is the compute Client
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List gets a list of compute operations.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
OrchestrationMode enumerates the values for orchestration mode.
type OrchestrationMode string
const (
// OrchestrationModeFlexible ...
OrchestrationModeFlexible OrchestrationMode = "Flexible"
// OrchestrationModeUniform ...
OrchestrationModeUniform OrchestrationMode = "Uniform"
)
func PossibleOrchestrationModeValues() []OrchestrationMode
PossibleOrchestrationModeValues returns an array of possible values for the OrchestrationMode const type.
OrchestrationServiceNames enumerates the values for orchestration service names.
type OrchestrationServiceNames string
const (
// OrchestrationServiceNamesAutomaticRepairs ...
OrchestrationServiceNamesAutomaticRepairs OrchestrationServiceNames = "AutomaticRepairs"
)
func PossibleOrchestrationServiceNamesValues() []OrchestrationServiceNames
PossibleOrchestrationServiceNamesValues returns an array of possible values for the OrchestrationServiceNames const type.
OrchestrationServiceState enumerates the values for orchestration service state.
type OrchestrationServiceState string
const (
// OrchestrationServiceStateNotRunning ...
OrchestrationServiceStateNotRunning OrchestrationServiceState = "NotRunning"
// OrchestrationServiceStateRunning ...
OrchestrationServiceStateRunning OrchestrationServiceState = "Running"
// OrchestrationServiceStateSuspended ...
OrchestrationServiceStateSuspended OrchestrationServiceState = "Suspended"
)
func PossibleOrchestrationServiceStateValues() []OrchestrationServiceState
PossibleOrchestrationServiceStateValues returns an array of possible values for the OrchestrationServiceState const type.
OrchestrationServiceStateAction enumerates the values for orchestration service state action.
type OrchestrationServiceStateAction string
const (
// OrchestrationServiceStateActionResume ...
OrchestrationServiceStateActionResume OrchestrationServiceStateAction = "Resume"
// OrchestrationServiceStateActionSuspend ...
OrchestrationServiceStateActionSuspend OrchestrationServiceStateAction = "Suspend"
)
func PossibleOrchestrationServiceStateActionValues() []OrchestrationServiceStateAction
PossibleOrchestrationServiceStateActionValues returns an array of possible values for the OrchestrationServiceStateAction const type.
OrchestrationServiceStateInput the input for OrchestrationServiceState
type OrchestrationServiceStateInput struct {
// ServiceName - The name of the service. Possible values include: 'OrchestrationServiceNamesAutomaticRepairs'
ServiceName OrchestrationServiceNames `json:"serviceName,omitempty"`
// Action - The action to be performed. Possible values include: 'OrchestrationServiceStateActionResume', 'OrchestrationServiceStateActionSuspend'
Action OrchestrationServiceStateAction `json:"action,omitempty"`
}
OrchestrationServiceSummary summary for an orchestration service of a virtual machine scale set.
type OrchestrationServiceSummary struct {
// ServiceName - READ-ONLY; The name of the service. Possible values include: 'OrchestrationServiceNamesAutomaticRepairs', 'OrchestrationServiceNamesDummyOrchestrationServiceName'
ServiceName OrchestrationServiceNames `json:"serviceName,omitempty"`
// ServiceState - READ-ONLY; The current state of the service. Possible values include: 'OrchestrationServiceStateNotRunning', 'OrchestrationServiceStateRunning', 'OrchestrationServiceStateSuspended'
ServiceState OrchestrationServiceState `json:"serviceState,omitempty"`
}
func (oss OrchestrationServiceSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OrchestrationServiceSummary.
PassNames enumerates the values for pass names.
type PassNames string
const (
// PassNamesOobeSystem ...
PassNamesOobeSystem PassNames = "OobeSystem"
)
func PossiblePassNamesValues() []PassNames
PossiblePassNamesValues returns an array of possible values for the PassNames const type.
PatchAssessmentState enumerates the values for patch assessment state.
type PatchAssessmentState string
const (
// PatchAssessmentStateAvailable ...
PatchAssessmentStateAvailable PatchAssessmentState = "Available"
// PatchAssessmentStateUnknown ...
PatchAssessmentStateUnknown PatchAssessmentState = "Unknown"
)
func PossiblePatchAssessmentStateValues() []PatchAssessmentState
PossiblePatchAssessmentStateValues returns an array of possible values for the PatchAssessmentState const type.
PatchInstallationDetail information about a specific patch that was encountered during an installation action.
type PatchInstallationDetail struct {
// PatchID - READ-ONLY; A unique identifier for the patch.
PatchID *string `json:"patchId,omitempty"`
// Name - READ-ONLY; The friendly name of the patch.
Name *string `json:"name,omitempty"`
// Version - READ-ONLY; The version string of the package. It may conform to Semantic Versioning. Only applies to Linux.
Version *string `json:"version,omitempty"`
// KbID - READ-ONLY; The KBID of the patch. Only applies to Windows patches.
KbID *string `json:"kbId,omitempty"`
// Classifications - READ-ONLY; The classification(s) of the patch as provided by the patch publisher.
Classifications *[]string `json:"classifications,omitempty"`
// InstallationState - READ-ONLY; The state of the patch after the installation operation completed. Possible values include: 'PatchInstallationStateUnknown', 'PatchInstallationStateInstalled', 'PatchInstallationStateFailed', 'PatchInstallationStateExcluded', 'PatchInstallationStateNotSelected', 'PatchInstallationStatePending'
InstallationState PatchInstallationState `json:"installationState,omitempty"`
}
func (pid PatchInstallationDetail) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchInstallationDetail.
PatchInstallationState enumerates the values for patch installation state.
type PatchInstallationState string
const (
// PatchInstallationStateExcluded ...
PatchInstallationStateExcluded PatchInstallationState = "Excluded"
// PatchInstallationStateFailed ...
PatchInstallationStateFailed PatchInstallationState = "Failed"
// PatchInstallationStateInstalled ...
PatchInstallationStateInstalled PatchInstallationState = "Installed"
// PatchInstallationStateNotSelected ...
PatchInstallationStateNotSelected PatchInstallationState = "NotSelected"
// PatchInstallationStatePending ...
PatchInstallationStatePending PatchInstallationState = "Pending"
// PatchInstallationStateUnknown ...
PatchInstallationStateUnknown PatchInstallationState = "Unknown"
)
func PossiblePatchInstallationStateValues() []PatchInstallationState
PossiblePatchInstallationStateValues returns an array of possible values for the PatchInstallationState const type.
PatchOperationStatus enumerates the values for patch operation status.
type PatchOperationStatus string
const (
// PatchOperationStatusCompletedWithWarnings ...
PatchOperationStatusCompletedWithWarnings PatchOperationStatus = "CompletedWithWarnings"
// PatchOperationStatusFailed ...
PatchOperationStatusFailed PatchOperationStatus = "Failed"
// PatchOperationStatusInProgress ...
PatchOperationStatusInProgress PatchOperationStatus = "InProgress"
// PatchOperationStatusSucceeded ...
PatchOperationStatusSucceeded PatchOperationStatus = "Succeeded"
// PatchOperationStatusUnknown ...
PatchOperationStatusUnknown PatchOperationStatus = "Unknown"
)
func PossiblePatchOperationStatusValues() []PatchOperationStatus
PossiblePatchOperationStatusValues returns an array of possible values for the PatchOperationStatus const type.
PatchSettings specifies settings related to VM Guest Patching on Windows.
type PatchSettings struct {
// PatchMode - Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true. Possible values include: 'WindowsVMGuestPatchModeManual', 'WindowsVMGuestPatchModeAutomaticByOS', 'WindowsVMGuestPatchModeAutomaticByPlatform'
PatchMode WindowsVMGuestPatchMode `json:"patchMode,omitempty"`
// EnableHotpatching - Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
EnableHotpatching *bool `json:"enableHotpatching,omitempty"`
// AssessmentMode - Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine.<br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. Possible values include: 'WindowsPatchAssessmentModeImageDefault', 'WindowsPatchAssessmentModeAutomaticByPlatform'
AssessmentMode WindowsPatchAssessmentMode `json:"assessmentMode,omitempty"`
}
PirCommunityGalleryResource base information about the community gallery resource in pir.
type PirCommunityGalleryResource struct {
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*CommunityGalleryIdentifier `json:"identifier,omitempty"`
}
func (pcgr PirCommunityGalleryResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PirCommunityGalleryResource.
func (pcgr *PirCommunityGalleryResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PirCommunityGalleryResource struct.
PirResource the Resource model definition.
type PirResource struct {
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (pr PirResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PirResource.
PirSharedGalleryResource base information about the shared gallery resource in pir.
type PirSharedGalleryResource struct {
*SharedGalleryIdentifier `json:"identifier,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (psgr PirSharedGalleryResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PirSharedGalleryResource.
func (psgr *PirSharedGalleryResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PirSharedGalleryResource struct.
Plan specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
type Plan struct {
// Name - The plan ID.
Name *string `json:"name,omitempty"`
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Product - Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
Product *string `json:"product,omitempty"`
// PromotionCode - The promotion code.
PromotionCode *string `json:"promotionCode,omitempty"`
}
PrivateEndpoint the Private Endpoint resource.
type PrivateEndpoint struct {
// ID - READ-ONLY; The ARM identifier for Private Endpoint
ID *string `json:"id,omitempty"`
}
func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpoint.
PrivateEndpointConnection the Private Endpoint Connection resource.
type PrivateEndpointConnection struct {
autorest.Response `json:"-"`
// PrivateEndpointConnectionProperties - Resource properties.
*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; private endpoint connection Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; private endpoint connection name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; private endpoint connection type
Type *string `json:"type,omitempty"`
}
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.
PrivateEndpointConnectionListResult a list of private link resources
type PrivateEndpointConnectionListResult struct {
autorest.Response `json:"-"`
// Value - Array of private endpoint connections
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.
NextLink *string `json:"nextLink,omitempty"`
}
func (peclr PrivateEndpointConnectionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
PrivateEndpointConnectionListResultIterator provides access to a complete listing of PrivateEndpointConnection values.
type PrivateEndpointConnectionListResultIterator struct {
// contains filtered or unexported fields
}
func NewPrivateEndpointConnectionListResultIterator(page PrivateEndpointConnectionListResultPage) PrivateEndpointConnectionListResultIterator
Creates a new instance of the PrivateEndpointConnectionListResultIterator type.
func (iter *PrivateEndpointConnectionListResultIterator) 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 *PrivateEndpointConnectionListResultIterator) 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 PrivateEndpointConnectionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PrivateEndpointConnectionListResultIterator) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
func (iter PrivateEndpointConnectionListResultIterator) Value() PrivateEndpointConnection
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PrivateEndpointConnectionListResultPage contains a page of PrivateEndpointConnection values.
type PrivateEndpointConnectionListResultPage struct {
// contains filtered or unexported fields
}
func NewPrivateEndpointConnectionListResultPage(cur PrivateEndpointConnectionListResult, getNextPage func(context.Context, PrivateEndpointConnectionListResult) (PrivateEndpointConnectionListResult, error)) PrivateEndpointConnectionListResultPage
Creates a new instance of the PrivateEndpointConnectionListResultPage type.
func (page *PrivateEndpointConnectionListResultPage) 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 *PrivateEndpointConnectionListResultPage) 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 PrivateEndpointConnectionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PrivateEndpointConnectionListResultPage) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
func (page PrivateEndpointConnectionListResultPage) Values() []PrivateEndpointConnection
Values returns the slice of values for the current page or nil if there are no values.
PrivateEndpointConnectionProperties properties of the PrivateEndpointConnectProperties.
type PrivateEndpointConnectionProperties struct {
// PrivateEndpoint - READ-ONLY; The resource of private end point.
PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
// PrivateLinkServiceConnectionState - A collection of information about the state of the connection between DiskAccess and Virtual Network.
PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
// ProvisioningState - The provisioning state of the private endpoint connection resource. Possible values include: 'PrivateEndpointConnectionProvisioningStateSucceeded', 'PrivateEndpointConnectionProvisioningStateCreating', 'PrivateEndpointConnectionProvisioningStateDeleting', 'PrivateEndpointConnectionProvisioningStateFailed'
ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}
func (pecp PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.
PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state.
type PrivateEndpointConnectionProvisioningState string
const (
// PrivateEndpointConnectionProvisioningStateCreating ...
PrivateEndpointConnectionProvisioningStateCreating PrivateEndpointConnectionProvisioningState = "Creating"
// PrivateEndpointConnectionProvisioningStateDeleting ...
PrivateEndpointConnectionProvisioningStateDeleting PrivateEndpointConnectionProvisioningState = "Deleting"
// PrivateEndpointConnectionProvisioningStateFailed ...
PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed"
// PrivateEndpointConnectionProvisioningStateSucceeded ...
PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)
func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState
PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.
PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status.
type PrivateEndpointServiceConnectionStatus string
const (
// PrivateEndpointServiceConnectionStatusApproved ...
PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
// PrivateEndpointServiceConnectionStatusPending ...
PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending"
// PrivateEndpointServiceConnectionStatusRejected ...
PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)
func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus
PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.
PrivateLinkResource a private link resource
type PrivateLinkResource struct {
// PrivateLinkResourceProperties - Resource properties.
*PrivateLinkResourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; private link resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; private link resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; private link resource type
Type *string `json:"type,omitempty"`
}
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.
PrivateLinkResourceListResult a list of private link resources
type PrivateLinkResourceListResult struct {
autorest.Response `json:"-"`
// Value - Array of private link resources
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
PrivateLinkResourceProperties properties of a private link resource.
type PrivateLinkResourceProperties struct {
// GroupID - READ-ONLY; The private link resource group id.
GroupID *string `json:"groupId,omitempty"`
// RequiredMembers - READ-ONLY; The private link resource required member names.
RequiredMembers *[]string `json:"requiredMembers,omitempty"`
// RequiredZoneNames - The private link resource DNS zone name.
RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
PrivateLinkServiceConnectionState a collection of information about the state of the connection between service consumer and provider.
type PrivateLinkServiceConnectionState struct {
// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'PrivateEndpointServiceConnectionStatusPending', 'PrivateEndpointServiceConnectionStatusApproved', 'PrivateEndpointServiceConnectionStatusRejected'
Status PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
// Description - The reason for approval/rejection of the connection.
Description *string `json:"description,omitempty"`
// ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer.
ActionsRequired *string `json:"actionsRequired,omitempty"`
}
PropertyUpdatesInProgress properties of the disk for which update is pending.
type PropertyUpdatesInProgress struct {
// TargetTier - The target performance tier of the disk if a tier change operation is in progress.
TargetTier *string `json:"targetTier,omitempty"`
}
ProtocolTypes enumerates the values for protocol types.
type ProtocolTypes string
const (
// ProtocolTypesHTTP ...
ProtocolTypesHTTP ProtocolTypes = "Http"
// ProtocolTypesHTTPS ...
ProtocolTypesHTTPS ProtocolTypes = "Https"
)
func PossibleProtocolTypesValues() []ProtocolTypes
PossibleProtocolTypesValues returns an array of possible values for the ProtocolTypes const type.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// ProvisioningStateCreating ...
ProvisioningStateCreating ProvisioningState = "Creating"
// ProvisioningStateDeleting ...
ProvisioningStateDeleting ProvisioningState = "Deleting"
// ProvisioningStateFailed ...
ProvisioningStateFailed ProvisioningState = "Failed"
// ProvisioningStateMigrating ...
ProvisioningStateMigrating ProvisioningState = "Migrating"
// ProvisioningStateSucceeded ...
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
// ProvisioningStateUpdating ...
ProvisioningStateUpdating ProvisioningState = "Updating"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProvisioningState1 enumerates the values for provisioning state 1.
type ProvisioningState1 string
const (
// ProvisioningState1Creating ...
ProvisioningState1Creating ProvisioningState1 = "Creating"
// ProvisioningState1Deleting ...
ProvisioningState1Deleting ProvisioningState1 = "Deleting"
// ProvisioningState1Failed ...
ProvisioningState1Failed ProvisioningState1 = "Failed"
// ProvisioningState1Migrating ...
ProvisioningState1Migrating ProvisioningState1 = "Migrating"
// ProvisioningState1Succeeded ...
ProvisioningState1Succeeded ProvisioningState1 = "Succeeded"
// ProvisioningState1Updating ...
ProvisioningState1Updating ProvisioningState1 = "Updating"
)
func PossibleProvisioningState1Values() []ProvisioningState1
PossibleProvisioningState1Values returns an array of possible values for the ProvisioningState1 const type.
ProvisioningState2 enumerates the values for provisioning state 2.
type ProvisioningState2 string
const (
// ProvisioningState2Creating ...
ProvisioningState2Creating ProvisioningState2 = "Creating"
// ProvisioningState2Deleting ...
ProvisioningState2Deleting ProvisioningState2 = "Deleting"
// ProvisioningState2Failed ...
ProvisioningState2Failed ProvisioningState2 = "Failed"
// ProvisioningState2Migrating ...
ProvisioningState2Migrating ProvisioningState2 = "Migrating"
// ProvisioningState2Succeeded ...
ProvisioningState2Succeeded ProvisioningState2 = "Succeeded"
// ProvisioningState2Updating ...
ProvisioningState2Updating ProvisioningState2 = "Updating"
)
func PossibleProvisioningState2Values() []ProvisioningState2
PossibleProvisioningState2Values returns an array of possible values for the ProvisioningState2 const type.
ProvisioningState3 enumerates the values for provisioning state 3.
type ProvisioningState3 string
const (
// ProvisioningState3Creating ...
ProvisioningState3Creating ProvisioningState3 = "Creating"
// ProvisioningState3Deleting ...
ProvisioningState3Deleting ProvisioningState3 = "Deleting"
// ProvisioningState3Failed ...
ProvisioningState3Failed ProvisioningState3 = "Failed"
// ProvisioningState3Migrating ...
ProvisioningState3Migrating ProvisioningState3 = "Migrating"
// ProvisioningState3Succeeded ...
ProvisioningState3Succeeded ProvisioningState3 = "Succeeded"
// ProvisioningState3Updating ...
ProvisioningState3Updating ProvisioningState3 = "Updating"
)
func PossibleProvisioningState3Values() []ProvisioningState3
PossibleProvisioningState3Values returns an array of possible values for the ProvisioningState3 const type.
ProximityPlacementGroup specifies information about the proximity placement group.
type ProximityPlacementGroup struct {
autorest.Response `json:"-"`
// ProximityPlacementGroupProperties - Describes the properties of a Proximity Placement Group.
*ProximityPlacementGroupProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (ppg ProximityPlacementGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroup.
func (ppg *ProximityPlacementGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProximityPlacementGroup struct.
ProximityPlacementGroupListResult the List Proximity Placement Group operation response.
type ProximityPlacementGroupListResult struct {
autorest.Response `json:"-"`
// Value - The list of proximity placement groups
Value *[]ProximityPlacementGroup `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of proximity placement groups.
NextLink *string `json:"nextLink,omitempty"`
}
func (ppglr ProximityPlacementGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ProximityPlacementGroupListResultIterator provides access to a complete listing of ProximityPlacementGroup values.
type ProximityPlacementGroupListResultIterator struct {
// contains filtered or unexported fields
}
func NewProximityPlacementGroupListResultIterator(page ProximityPlacementGroupListResultPage) ProximityPlacementGroupListResultIterator
Creates a new instance of the ProximityPlacementGroupListResultIterator type.
func (iter *ProximityPlacementGroupListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ProximityPlacementGroupListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ProximityPlacementGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProximityPlacementGroupListResultIterator) Response() ProximityPlacementGroupListResult
Response returns the raw server response from the last page request.
func (iter ProximityPlacementGroupListResultIterator) Value() ProximityPlacementGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ProximityPlacementGroupListResultPage contains a page of ProximityPlacementGroup values.
type ProximityPlacementGroupListResultPage struct {
// contains filtered or unexported fields
}
func NewProximityPlacementGroupListResultPage(cur ProximityPlacementGroupListResult, getNextPage func(context.Context, ProximityPlacementGroupListResult) (ProximityPlacementGroupListResult, error)) ProximityPlacementGroupListResultPage
Creates a new instance of the ProximityPlacementGroupListResultPage type.
func (page *ProximityPlacementGroupListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ProximityPlacementGroupListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ProximityPlacementGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProximityPlacementGroupListResultPage) Response() ProximityPlacementGroupListResult
Response returns the raw server response from the last page request.
func (page ProximityPlacementGroupListResultPage) Values() []ProximityPlacementGroup
Values returns the slice of values for the current page or nil if there are no values.
ProximityPlacementGroupProperties describes the properties of a Proximity Placement Group.
type ProximityPlacementGroupProperties struct {
// ProximityPlacementGroupType - Specifies the type of the proximity placement group. <br><br> Possible values are: <br><br> **Standard** : Co-locate resources within an Azure region or Availability Zone. <br><br> **Ultra** : For future use. Possible values include: 'ProximityPlacementGroupTypeStandard', 'ProximityPlacementGroupTypeUltra'
ProximityPlacementGroupType ProximityPlacementGroupType `json:"proximityPlacementGroupType,omitempty"`
// VirtualMachines - READ-ONLY; A list of references to all virtual machines in the proximity placement group.
VirtualMachines *[]SubResourceWithColocationStatus `json:"virtualMachines,omitempty"`
// VirtualMachineScaleSets - READ-ONLY; A list of references to all virtual machine scale sets in the proximity placement group.
VirtualMachineScaleSets *[]SubResourceWithColocationStatus `json:"virtualMachineScaleSets,omitempty"`
// AvailabilitySets - READ-ONLY; A list of references to all availability sets in the proximity placement group.
AvailabilitySets *[]SubResourceWithColocationStatus `json:"availabilitySets,omitempty"`
// ColocationStatus - Describes colocation status of the Proximity Placement Group.
ColocationStatus *InstanceViewStatus `json:"colocationStatus,omitempty"`
}
func (ppgp ProximityPlacementGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroupProperties.
ProximityPlacementGroupType enumerates the values for proximity placement group type.
type ProximityPlacementGroupType string
const (
// ProximityPlacementGroupTypeStandard ...
ProximityPlacementGroupTypeStandard ProximityPlacementGroupType = "Standard"
// ProximityPlacementGroupTypeUltra ...
ProximityPlacementGroupTypeUltra ProximityPlacementGroupType = "Ultra"
)
func PossibleProximityPlacementGroupTypeValues() []ProximityPlacementGroupType
PossibleProximityPlacementGroupTypeValues returns an array of possible values for the ProximityPlacementGroupType const type.
ProximityPlacementGroupUpdate specifies information about the proximity placement group.
type ProximityPlacementGroupUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (ppgu ProximityPlacementGroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroupUpdate.
ProximityPlacementGroupsClient is the compute Client
type ProximityPlacementGroupsClient struct {
BaseClient
}
func NewProximityPlacementGroupsClient(subscriptionID string) ProximityPlacementGroupsClient
NewProximityPlacementGroupsClient creates an instance of the ProximityPlacementGroupsClient client.
func NewProximityPlacementGroupsClientWithBaseURI(baseURI string, subscriptionID string) ProximityPlacementGroupsClient
NewProximityPlacementGroupsClientWithBaseURI creates an instance of the ProximityPlacementGroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ProximityPlacementGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroup) (result ProximityPlacementGroup, err error)
CreateOrUpdate create or update a proximity placement group. Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group. parameters - parameters supplied to the Create Proximity Placement Group operation.
func (client ProximityPlacementGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProximityPlacementGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result ProximityPlacementGroup, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) Delete(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string) (result autorest.Response, err error)
Delete delete a proximity placement group. Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group.
func (client ProximityPlacementGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProximityPlacementGroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) Get(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, includeColocationStatus string) (result ProximityPlacementGroup, err error)
Get retrieves information about a proximity placement group . Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group. includeColocationStatus - includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.
func (client ProximityPlacementGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, includeColocationStatus string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ProximityPlacementGroupsClient) GetResponder(resp *http.Response) (result ProximityPlacementGroup, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProximityPlacementGroupListResultPage, err error)
ListByResourceGroup lists all proximity placement groups in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ProximityPlacementGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProximityPlacementGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProximityPlacementGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ProximityPlacementGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result ProximityPlacementGroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) ListBySubscription(ctx context.Context) (result ProximityPlacementGroupListResultPage, err error)
ListBySubscription lists all proximity placement groups in a subscription.
func (client ProximityPlacementGroupsClient) ListBySubscriptionComplete(ctx context.Context) (result ProximityPlacementGroupListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProximityPlacementGroupsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client ProximityPlacementGroupsClient) ListBySubscriptionResponder(resp *http.Response) (result ProximityPlacementGroupListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client ProximityPlacementGroupsClient) Update(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroupUpdate) (result ProximityPlacementGroup, err error)
Update update a proximity placement group. Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group. parameters - parameters supplied to the Update Proximity Placement Group operation.
func (client ProximityPlacementGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ProximityPlacementGroupsClient) UpdateResponder(resp *http.Response) (result ProximityPlacementGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ProxyOnlyResource the ProxyOnly Resource model definition.
type ProxyOnlyResource struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
}
func (por ProxyOnlyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyOnlyResource.
ProxyResource the resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location
type ProxyResource struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
PublicIPAddressSku describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
type PublicIPAddressSku struct {
// Name - Specify public IP sku name. Possible values include: 'PublicIPAddressSkuNameBasic', 'PublicIPAddressSkuNameStandard'
Name PublicIPAddressSkuName `json:"name,omitempty"`
// Tier - Specify public IP sku tier. Possible values include: 'PublicIPAddressSkuTierRegional', 'PublicIPAddressSkuTierGlobal'
Tier PublicIPAddressSkuTier `json:"tier,omitempty"`
}
PublicIPAddressSkuName enumerates the values for public ip address sku name.
type PublicIPAddressSkuName string
const (
// PublicIPAddressSkuNameBasic ...
PublicIPAddressSkuNameBasic PublicIPAddressSkuName = "Basic"
// PublicIPAddressSkuNameStandard ...
PublicIPAddressSkuNameStandard PublicIPAddressSkuName = "Standard"
)
func PossiblePublicIPAddressSkuNameValues() []PublicIPAddressSkuName
PossiblePublicIPAddressSkuNameValues returns an array of possible values for the PublicIPAddressSkuName const type.
PublicIPAddressSkuTier enumerates the values for public ip address sku tier.
type PublicIPAddressSkuTier string
const (
// PublicIPAddressSkuTierGlobal ...
PublicIPAddressSkuTierGlobal PublicIPAddressSkuTier = "Global"
// PublicIPAddressSkuTierRegional ...
PublicIPAddressSkuTierRegional PublicIPAddressSkuTier = "Regional"
)
func PossiblePublicIPAddressSkuTierValues() []PublicIPAddressSkuTier
PossiblePublicIPAddressSkuTierValues returns an array of possible values for the PublicIPAddressSkuTier const type.
PublicIPAllocationMethod enumerates the values for public ip allocation method.
type PublicIPAllocationMethod string
const (
// PublicIPAllocationMethodDynamic ...
PublicIPAllocationMethodDynamic PublicIPAllocationMethod = "Dynamic"
// PublicIPAllocationMethodStatic ...
PublicIPAllocationMethodStatic PublicIPAllocationMethod = "Static"
)
func PossiblePublicIPAllocationMethodValues() []PublicIPAllocationMethod
PossiblePublicIPAllocationMethodValues returns an array of possible values for the PublicIPAllocationMethod const type.
PublicNetworkAccess enumerates the values for public network access.
type PublicNetworkAccess string
const (
// PublicNetworkAccessDisabled You cannot access the underlying data of the disk publicly on the internet
// even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your
// trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.
PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
// PublicNetworkAccessEnabled You can generate a SAS URI to access the underlying data of the disk publicly
// on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI
// only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.
PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
)
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
PurchasePlan used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
type PurchasePlan struct {
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Name - The plan ID.
Name *string `json:"name,omitempty"`
// Product - Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
Product *string `json:"product,omitempty"`
// PromotionCode - The Offer Promotion Code.
PromotionCode *string `json:"promotionCode,omitempty"`
}
ReadCloser ...
type ReadCloser struct {
autorest.Response `json:"-"`
Value *io.ReadCloser `json:"value,omitempty"`
}
RecommendedMachineConfiguration the properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
type RecommendedMachineConfiguration struct {
VCPUs *ResourceRange `json:"vCPUs,omitempty"`
Memory *ResourceRange `json:"memory,omitempty"`
}
RecoveryWalkResponse response after calling a manual recovery walk
type RecoveryWalkResponse struct {
autorest.Response `json:"-"`
// WalkPerformed - READ-ONLY; Whether the recovery walk was performed
WalkPerformed *bool `json:"walkPerformed,omitempty"`
// NextPlatformUpdateDomain - READ-ONLY; The next update domain that needs to be walked. Null means walk spanning all update domains has been completed
NextPlatformUpdateDomain *int32 `json:"nextPlatformUpdateDomain,omitempty"`
}
func (rwr RecoveryWalkResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecoveryWalkResponse.
RegionalReplicationStatus this is the regional replication status.
type RegionalReplicationStatus struct {
// Region - READ-ONLY; The region to which the gallery image version is being replicated to.
Region *string `json:"region,omitempty"`
// State - READ-ONLY; This is the regional replication state. Possible values include: 'ReplicationStateUnknown', 'ReplicationStateReplicating', 'ReplicationStateCompleted', 'ReplicationStateFailed'
State ReplicationState `json:"state,omitempty"`
// Details - READ-ONLY; The details of the replication status.
Details *string `json:"details,omitempty"`
// Progress - READ-ONLY; It indicates progress of the replication job.
Progress *int32 `json:"progress,omitempty"`
}
func (rrs RegionalReplicationStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegionalReplicationStatus.
RegionalSharingStatus gallery regional sharing status
type RegionalSharingStatus struct {
// Region - Region name
Region *string `json:"region,omitempty"`
// State - Gallery sharing state in current region. Possible values include: 'SharingStateSucceeded', 'SharingStateInProgress', 'SharingStateFailed', 'SharingStateUnknown'
State SharingState `json:"state,omitempty"`
// Details - Details of gallery regional sharing failure.
Details *string `json:"details,omitempty"`
}
RepairAction enumerates the values for repair action.
type RepairAction string
const (
// RepairActionReimage ...
RepairActionReimage RepairAction = "Reimage"
// RepairActionReplace ...
RepairActionReplace RepairAction = "Replace"
// RepairActionRestart ...
RepairActionRestart RepairAction = "Restart"
)
func PossibleRepairActionValues() []RepairAction
PossibleRepairActionValues returns an array of possible values for the RepairAction const type.
ReplicationMode enumerates the values for replication mode.
type ReplicationMode string
const (
// ReplicationModeFull ...
ReplicationModeFull ReplicationMode = "Full"
// ReplicationModeShallow ...
ReplicationModeShallow ReplicationMode = "Shallow"
)
func PossibleReplicationModeValues() []ReplicationMode
PossibleReplicationModeValues returns an array of possible values for the ReplicationMode const type.
ReplicationState enumerates the values for replication state.
type ReplicationState string
const (
// ReplicationStateCompleted ...
ReplicationStateCompleted ReplicationState = "Completed"
// ReplicationStateFailed ...
ReplicationStateFailed ReplicationState = "Failed"
// ReplicationStateReplicating ...
ReplicationStateReplicating ReplicationState = "Replicating"
// ReplicationStateUnknown ...
ReplicationStateUnknown ReplicationState = "Unknown"
)
func PossibleReplicationStateValues() []ReplicationState
PossibleReplicationStateValues returns an array of possible values for the ReplicationState const type.
ReplicationStatus this is the replication status of the gallery image version.
type ReplicationStatus struct {
// AggregatedState - READ-ONLY; This is the aggregated replication status based on all the regional replication status flags. Possible values include: 'AggregatedReplicationStateUnknown', 'AggregatedReplicationStateInProgress', 'AggregatedReplicationStateCompleted', 'AggregatedReplicationStateFailed'
AggregatedState AggregatedReplicationState `json:"aggregatedState,omitempty"`
// Summary - READ-ONLY; This is a summary of replication status for each region.
Summary *[]RegionalReplicationStatus `json:"summary,omitempty"`
}
func (rs ReplicationStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReplicationStatus.
ReplicationStatusTypes enumerates the values for replication status types.
type ReplicationStatusTypes string
const (
// ReplicationStatusTypesReplicationStatus ...
ReplicationStatusTypesReplicationStatus ReplicationStatusTypes = "ReplicationStatus"
)
func PossibleReplicationStatusTypesValues() []ReplicationStatusTypes
PossibleReplicationStatusTypesValues returns an array of possible values for the ReplicationStatusTypes const type.
RequestRateByIntervalInput api request input for LogAnalytics getRequestRateByInterval Api.
type RequestRateByIntervalInput struct {
// IntervalLength - Interval value in minutes used to create LogAnalytics call rate logs. Possible values include: 'IntervalInMinsThreeMins', 'IntervalInMinsFiveMins', 'IntervalInMinsThirtyMins', 'IntervalInMinsSixtyMins'
IntervalLength IntervalInMins `json:"intervalLength,omitempty"`
// BlobContainerSasURI - SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
BlobContainerSasURI *string `json:"blobContainerSasUri,omitempty"`
// FromTime - From time of the query
FromTime *date.Time `json:"fromTime,omitempty"`
// ToTime - To time of the query
ToTime *date.Time `json:"toTime,omitempty"`
// GroupByThrottlePolicy - Group query result by Throttle Policy applied.
GroupByThrottlePolicy *bool `json:"groupByThrottlePolicy,omitempty"`
// GroupByOperationName - Group query result by Operation Name.
GroupByOperationName *bool `json:"groupByOperationName,omitempty"`
// GroupByResourceName - Group query result by Resource Name.
GroupByResourceName *bool `json:"groupByResourceName,omitempty"`
// GroupByClientApplicationID - Group query result by Client Application ID.
GroupByClientApplicationID *bool `json:"groupByClientApplicationId,omitempty"`
// GroupByUserAgent - Group query result by User Agent.
GroupByUserAgent *bool `json:"groupByUserAgent,omitempty"`
}
Resource the Resource model definition.
type Resource struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// ResourceIdentityTypeNone ...
ResourceIdentityTypeNone ResourceIdentityType = "None"
// ResourceIdentityTypeSystemAssigned ...
ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
// ResourceIdentityTypeSystemAssignedUserAssigned ...
ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
// ResourceIdentityTypeUserAssigned ...
ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
ResourceInstanceViewStatus instance view status.
type ResourceInstanceViewStatus struct {
// Code - READ-ONLY; The status code.
Code *string `json:"code,omitempty"`
// DisplayStatus - READ-ONLY; The short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - READ-ONLY; The detailed status message, including for alerts and error messages.
Message *string `json:"message,omitempty"`
// Time - READ-ONLY; The time of the status.
Time *date.Time `json:"time,omitempty"`
// Level - The level code. Possible values include: 'StatusLevelTypesInfo', 'StatusLevelTypesWarning', 'StatusLevelTypesError'
Level StatusLevelTypes `json:"level,omitempty"`
}
func (rivs ResourceInstanceViewStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceInstanceViewStatus.
ResourceRange describes the resource range.
type ResourceRange struct {
// Min - The minimum number of the resource.
Min *int32 `json:"min,omitempty"`
// Max - The maximum number of the resource.
Max *int32 `json:"max,omitempty"`
}
ResourceSku describes an available Compute SKU.
type ResourceSku struct {
// ResourceType - READ-ONLY; The type of resource the SKU applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Name - READ-ONLY; The name of SKU.
Name *string `json:"name,omitempty"`
// Tier - READ-ONLY; Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**
Tier *string `json:"tier,omitempty"`
// Size - READ-ONLY; The Size of the SKU.
Size *string `json:"size,omitempty"`
// Family - READ-ONLY; The Family of this particular SKU.
Family *string `json:"family,omitempty"`
// Kind - READ-ONLY; The Kind of resources that are supported in this SKU.
Kind *string `json:"kind,omitempty"`
// Capacity - READ-ONLY; Specifies the number of virtual machines in the scale set.
Capacity *ResourceSkuCapacity `json:"capacity,omitempty"`
// Locations - READ-ONLY; The set of locations that the SKU is available.
Locations *[]string `json:"locations,omitempty"`
// LocationInfo - READ-ONLY; A list of locations and availability zones in those locations where the SKU is available.
LocationInfo *[]ResourceSkuLocationInfo `json:"locationInfo,omitempty"`
// APIVersions - READ-ONLY; The api versions that support this SKU.
APIVersions *[]string `json:"apiVersions,omitempty"`
// Costs - READ-ONLY; Metadata for retrieving price info.
Costs *[]ResourceSkuCosts `json:"costs,omitempty"`
// Capabilities - READ-ONLY; A name value pair to describe the capability.
Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
// Restrictions - READ-ONLY; The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
}
func (rs ResourceSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSku.
ResourceSkuCapabilities describes The SKU capabilities object.
type ResourceSkuCapabilities struct {
// Name - READ-ONLY; An invariant to describe the feature.
Name *string `json:"name,omitempty"`
// Value - READ-ONLY; An invariant if the feature is measured by quantity.
Value *string `json:"value,omitempty"`
}
func (rsc ResourceSkuCapabilities) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCapabilities.
ResourceSkuCapacity describes scaling information of a SKU.
type ResourceSkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default capacity.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'ResourceSkuCapacityScaleTypeAutomatic', 'ResourceSkuCapacityScaleTypeManual', 'ResourceSkuCapacityScaleTypeNone'
ScaleType ResourceSkuCapacityScaleType `json:"scaleType,omitempty"`
}
func (rsc ResourceSkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCapacity.
ResourceSkuCapacityScaleType enumerates the values for resource sku capacity scale type.
type ResourceSkuCapacityScaleType string
const (
// ResourceSkuCapacityScaleTypeAutomatic ...
ResourceSkuCapacityScaleTypeAutomatic ResourceSkuCapacityScaleType = "Automatic"
// ResourceSkuCapacityScaleTypeManual ...
ResourceSkuCapacityScaleTypeManual ResourceSkuCapacityScaleType = "Manual"
// ResourceSkuCapacityScaleTypeNone ...
ResourceSkuCapacityScaleTypeNone ResourceSkuCapacityScaleType = "None"
)
func PossibleResourceSkuCapacityScaleTypeValues() []ResourceSkuCapacityScaleType
PossibleResourceSkuCapacityScaleTypeValues returns an array of possible values for the ResourceSkuCapacityScaleType const type.
ResourceSkuCosts describes metadata for retrieving price info.
type ResourceSkuCosts struct {
// MeterID - READ-ONLY; Used for querying price from commerce.
MeterID *string `json:"meterID,omitempty"`
// Quantity - READ-ONLY; The multiplier is needed to extend the base metered cost.
Quantity *int64 `json:"quantity,omitempty"`
// ExtendedUnit - READ-ONLY; An invariant to show the extended unit.
ExtendedUnit *string `json:"extendedUnit,omitempty"`
}
func (rsc ResourceSkuCosts) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCosts.
ResourceSkuLocationInfo describes an available Compute SKU Location Information.
type ResourceSkuLocationInfo struct {
// Location - READ-ONLY; Location of the SKU
Location *string `json:"location,omitempty"`
// Zones - READ-ONLY; List of availability zones where the SKU is supported.
Zones *[]string `json:"zones,omitempty"`
// ZoneDetails - READ-ONLY; Details of capabilities available to a SKU in specific zones.
ZoneDetails *[]ResourceSkuZoneDetails `json:"zoneDetails,omitempty"`
// ExtendedLocations - READ-ONLY; The names of extended locations.
ExtendedLocations *[]string `json:"extendedLocations,omitempty"`
// Type - READ-ONLY; The type of the extended location. Possible values include: 'ExtendedLocationTypeEdgeZone'
Type ExtendedLocationType `json:"type,omitempty"`
}
func (rsli ResourceSkuLocationInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuLocationInfo.
ResourceSkuRestrictionInfo describes an available Compute SKU Restriction Information.
type ResourceSkuRestrictionInfo struct {
// Locations - READ-ONLY; Locations where the SKU is restricted
Locations *[]string `json:"locations,omitempty"`
// Zones - READ-ONLY; List of availability zones where the SKU is restricted.
Zones *[]string `json:"zones,omitempty"`
}
func (rsri ResourceSkuRestrictionInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuRestrictionInfo.
ResourceSkuRestrictions describes scaling information of a SKU.
type ResourceSkuRestrictions struct {
// Type - READ-ONLY; The type of restrictions. Possible values include: 'ResourceSkuRestrictionsTypeLocation', 'ResourceSkuRestrictionsTypeZone'
Type ResourceSkuRestrictionsType `json:"type,omitempty"`
// Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
Values *[]string `json:"values,omitempty"`
// RestrictionInfo - READ-ONLY; The information about the restriction where the SKU cannot be used.
RestrictionInfo *ResourceSkuRestrictionInfo `json:"restrictionInfo,omitempty"`
// ReasonCode - READ-ONLY; The reason for restriction. Possible values include: 'ResourceSkuRestrictionsReasonCodeQuotaID', 'ResourceSkuRestrictionsReasonCodeNotAvailableForSubscription'
ReasonCode ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
}
func (rsr ResourceSkuRestrictions) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuRestrictions.
ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.
type ResourceSkuRestrictionsReasonCode string
const (
// ResourceSkuRestrictionsReasonCodeNotAvailableForSubscription ...
ResourceSkuRestrictionsReasonCodeNotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
// ResourceSkuRestrictionsReasonCodeQuotaID ...
ResourceSkuRestrictionsReasonCodeQuotaID ResourceSkuRestrictionsReasonCode = "QuotaId"
)
func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode
PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.
ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.
type ResourceSkuRestrictionsType string
const (
// ResourceSkuRestrictionsTypeLocation ...
ResourceSkuRestrictionsTypeLocation ResourceSkuRestrictionsType = "Location"
// ResourceSkuRestrictionsTypeZone ...
ResourceSkuRestrictionsTypeZone ResourceSkuRestrictionsType = "Zone"
)
func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType
PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.
ResourceSkuZoneDetails describes The zonal capabilities of a SKU.
type ResourceSkuZoneDetails struct {
// Name - READ-ONLY; The set of zones that the SKU is available in with the specified capabilities.
Name *[]string `json:"name,omitempty"`
// Capabilities - READ-ONLY; A list of capabilities that are available for the SKU in the specified list of zones.
Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
}
func (rszd ResourceSkuZoneDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuZoneDetails.
ResourceSkusClient is the compute Client
type ResourceSkusClient struct {
BaseClient
}
func NewResourceSkusClient(subscriptionID string) ResourceSkusClient
NewResourceSkusClient creates an instance of the ResourceSkusClient client.
func NewResourceSkusClientWithBaseURI(baseURI string, subscriptionID string) ResourceSkusClient
NewResourceSkusClientWithBaseURI creates an instance of the ResourceSkusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ResourceSkusClient) List(ctx context.Context, filter string, includeExtendedLocations string) (result ResourceSkusResultPage, err error)
List gets the list of Microsoft.Compute SKUs available for your Subscription. Parameters: filter - the filter to apply on the operation. Only **location** filter is supported currently. includeExtendedLocations - to Include Extended Locations information or not in the response.
func (client ResourceSkusClient) ListComplete(ctx context.Context, filter string, includeExtendedLocations string) (result ResourceSkusResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ResourceSkusClient) ListPreparer(ctx context.Context, filter string, includeExtendedLocations string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ResourceSkusClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ResourceSkusResult the List Resource Skus operation response.
type ResourceSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the subscription.
Value *[]ResourceSku `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus
NextLink *string `json:"nextLink,omitempty"`
}
func (rsr ResourceSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.
type ResourceSkusResultIterator struct {
// contains filtered or unexported fields
}
func NewResourceSkusResultIterator(page ResourceSkusResultPage) ResourceSkusResultIterator
Creates a new instance of the ResourceSkusResultIterator type.
func (iter *ResourceSkusResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ResourceSkusResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ResourceSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceSkusResultIterator) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (iter ResourceSkusResultIterator) Value() ResourceSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ResourceSkusResultPage contains a page of ResourceSku values.
type ResourceSkusResultPage struct {
// contains filtered or unexported fields
}
func NewResourceSkusResultPage(cur ResourceSkusResult, getNextPage func(context.Context, ResourceSkusResult) (ResourceSkusResult, error)) ResourceSkusResultPage
Creates a new instance of the ResourceSkusResultPage type.
func (page *ResourceSkusResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ResourceSkusResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ResourceSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceSkusResultPage) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (page ResourceSkusResultPage) Values() []ResourceSku
Values returns the slice of values for the current page or nil if there are no values.
ResourceURIList the List resources which are encrypted with the disk encryption set.
type ResourceURIList struct {
autorest.Response `json:"-"`
// Value - A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set.
Value *[]string `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources.
NextLink *string `json:"nextLink,omitempty"`
}
func (rul ResourceURIList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ResourceURIListIterator provides access to a complete listing of string values.
type ResourceURIListIterator struct {
// contains filtered or unexported fields
}
func NewResourceURIListIterator(page ResourceURIListPage) ResourceURIListIterator
Creates a new instance of the ResourceURIListIterator type.
func (iter *ResourceURIListIterator) 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 *ResourceURIListIterator) 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 ResourceURIListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceURIListIterator) Response() ResourceURIList
Response returns the raw server response from the last page request.
func (iter ResourceURIListIterator) Value() string
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ResourceURIListPage contains a page of string values.
type ResourceURIListPage struct {
// contains filtered or unexported fields
}
func NewResourceURIListPage(cur ResourceURIList, getNextPage func(context.Context, ResourceURIList) (ResourceURIList, error)) ResourceURIListPage
Creates a new instance of the ResourceURIListPage type.
func (page *ResourceURIListPage) 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 *ResourceURIListPage) 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 ResourceURIListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceURIListPage) Response() ResourceURIList
Response returns the raw server response from the last page request.
func (page ResourceURIListPage) Values() []string
Values returns the slice of values for the current page or nil if there are no values.
RestorePoint restore Point details.
type RestorePoint struct {
autorest.Response `json:"-"`
*RestorePointProperties `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"`
}
func (rp RestorePoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePoint.
func (rp *RestorePoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RestorePoint struct.
RestorePointCollection create or update Restore Point collection parameters.
type RestorePointCollection struct {
autorest.Response `json:"-"`
*RestorePointCollectionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (RPCVar RestorePointCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePointCollection.
func (RPCVar *RestorePointCollection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RestorePointCollection struct.
RestorePointCollectionExpandOptions enumerates the values for restore point collection expand options.
type RestorePointCollectionExpandOptions string
const (
// RestorePointCollectionExpandOptionsRestorePoints ...
RestorePointCollectionExpandOptionsRestorePoints RestorePointCollectionExpandOptions = "restorePoints"
)
func PossibleRestorePointCollectionExpandOptionsValues() []RestorePointCollectionExpandOptions
PossibleRestorePointCollectionExpandOptionsValues returns an array of possible values for the RestorePointCollectionExpandOptions const type.
RestorePointCollectionListResult the List restore point collection operation response.
type RestorePointCollectionListResult struct {
autorest.Response `json:"-"`
// Value - Gets the list of restore point collections.
Value *[]RestorePointCollection `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections
NextLink *string `json:"nextLink,omitempty"`
}
func (rpclr RestorePointCollectionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RestorePointCollectionListResultIterator provides access to a complete listing of RestorePointCollection values.
type RestorePointCollectionListResultIterator struct {
// contains filtered or unexported fields
}
func NewRestorePointCollectionListResultIterator(page RestorePointCollectionListResultPage) RestorePointCollectionListResultIterator
Creates a new instance of the RestorePointCollectionListResultIterator type.
func (iter *RestorePointCollectionListResultIterator) 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 *RestorePointCollectionListResultIterator) 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 RestorePointCollectionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RestorePointCollectionListResultIterator) Response() RestorePointCollectionListResult
Response returns the raw server response from the last page request.
func (iter RestorePointCollectionListResultIterator) Value() RestorePointCollection
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RestorePointCollectionListResultPage contains a page of RestorePointCollection values.
type RestorePointCollectionListResultPage struct {
// contains filtered or unexported fields
}
func NewRestorePointCollectionListResultPage(cur RestorePointCollectionListResult, getNextPage func(context.Context, RestorePointCollectionListResult) (RestorePointCollectionListResult, error)) RestorePointCollectionListResultPage
Creates a new instance of the RestorePointCollectionListResultPage type.
func (page *RestorePointCollectionListResultPage) 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 *RestorePointCollectionListResultPage) 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 RestorePointCollectionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RestorePointCollectionListResultPage) Response() RestorePointCollectionListResult
Response returns the raw server response from the last page request.
func (page RestorePointCollectionListResultPage) Values() []RestorePointCollection
Values returns the slice of values for the current page or nil if there are no values.
RestorePointCollectionProperties the restore point collection properties.
type RestorePointCollectionProperties struct {
Source *RestorePointCollectionSourceProperties `json:"source,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state of the restore point collection.
ProvisioningState *string `json:"provisioningState,omitempty"`
// RestorePointCollectionID - READ-ONLY; The unique id of the restore point collection.
RestorePointCollectionID *string `json:"restorePointCollectionId,omitempty"`
// RestorePoints - READ-ONLY; A list containing all restore points created under this restore point collection.
RestorePoints *[]RestorePoint `json:"restorePoints,omitempty"`
}
func (rpcp RestorePointCollectionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePointCollectionProperties.
RestorePointCollectionSourceProperties the properties of the source resource that this restore point collection is created from.
type RestorePointCollectionSourceProperties struct {
// Location - READ-ONLY; Location of the source resource used to create this restore point collection.
Location *string `json:"location,omitempty"`
// ID - Resource Id of the source resource used to create this restore point collection
ID *string `json:"id,omitempty"`
}
func (rpcsp RestorePointCollectionSourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePointCollectionSourceProperties.
RestorePointCollectionUpdate update Restore Point collection parameters.
type RestorePointCollectionUpdate struct {
*RestorePointCollectionProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (rpcu RestorePointCollectionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePointCollectionUpdate.
func (rpcu *RestorePointCollectionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RestorePointCollectionUpdate struct.
RestorePointCollectionsClient is the compute Client
type RestorePointCollectionsClient struct {
BaseClient
}
func NewRestorePointCollectionsClient(subscriptionID string) RestorePointCollectionsClient
NewRestorePointCollectionsClient creates an instance of the RestorePointCollectionsClient client.
func NewRestorePointCollectionsClientWithBaseURI(baseURI string, subscriptionID string) RestorePointCollectionsClient
NewRestorePointCollectionsClientWithBaseURI creates an instance of the RestorePointCollectionsClient 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 RestorePointCollectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, restorePointCollectionName string, parameters RestorePointCollection) (result RestorePointCollection, err error)
CreateOrUpdate the operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection. parameters - parameters supplied to the Create or Update restore point collection operation.
func (client RestorePointCollectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, parameters RestorePointCollection) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client RestorePointCollectionsClient) CreateOrUpdateResponder(resp *http.Response) (result RestorePointCollection, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client RestorePointCollectionsClient) 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 RestorePointCollectionsClient) Delete(ctx context.Context, resourceGroupName string, restorePointCollectionName string) (result RestorePointCollectionsDeleteFuture, err error)
Delete the operation to delete the restore point collection. This operation will also delete all the contained restore points. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the Restore Point Collection.
func (client RestorePointCollectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RestorePointCollectionsClient) 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 RestorePointCollectionsClient) DeleteSender(req *http.Request) (future RestorePointCollectionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RestorePointCollectionsClient) Get(ctx context.Context, resourceGroupName string, restorePointCollectionName string, expand RestorePointCollectionExpandOptions) (result RestorePointCollection, err error)
Get the operation to get the restore point collection. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection. expand - the expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection.
func (client RestorePointCollectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, expand RestorePointCollectionExpandOptions) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RestorePointCollectionsClient) GetResponder(resp *http.Response) (result RestorePointCollection, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client RestorePointCollectionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client RestorePointCollectionsClient) List(ctx context.Context, resourceGroupName string) (result RestorePointCollectionListResultPage, err error)
List gets the list of restore point collections in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client RestorePointCollectionsClient) ListAll(ctx context.Context) (result RestorePointCollectionListResultPage, err error)
ListAll gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
func (client RestorePointCollectionsClient) ListAllComplete(ctx context.Context) (result RestorePointCollectionListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client RestorePointCollectionsClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client RestorePointCollectionsClient) ListAllResponder(resp *http.Response) (result RestorePointCollectionListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client RestorePointCollectionsClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client RestorePointCollectionsClient) ListComplete(ctx context.Context, resourceGroupName string) (result RestorePointCollectionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client RestorePointCollectionsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client RestorePointCollectionsClient) ListResponder(resp *http.Response) (result RestorePointCollectionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client RestorePointCollectionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client RestorePointCollectionsClient) Update(ctx context.Context, resourceGroupName string, restorePointCollectionName string, parameters RestorePointCollectionUpdate) (result RestorePointCollection, err error)
Update the operation to update the restore point collection. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection. parameters - parameters supplied to the Update restore point collection operation.
func (client RestorePointCollectionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, parameters RestorePointCollectionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client RestorePointCollectionsClient) UpdateResponder(resp *http.Response) (result RestorePointCollection, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client RestorePointCollectionsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
RestorePointCollectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RestorePointCollectionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RestorePointCollectionsClient) (autorest.Response, error)
}
func (future *RestorePointCollectionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RestorePointExpandOptions enumerates the values for restore point expand options.
type RestorePointExpandOptions string
const (
// RestorePointExpandOptionsInstanceView ...
RestorePointExpandOptionsInstanceView RestorePointExpandOptions = "instanceView"
)
func PossibleRestorePointExpandOptionsValues() []RestorePointExpandOptions
PossibleRestorePointExpandOptionsValues returns an array of possible values for the RestorePointExpandOptions const type.
RestorePointInstanceView the instance view of a restore point.
type RestorePointInstanceView struct {
// DiskRestorePoints - The disk restore points information.
DiskRestorePoints *[]DiskRestorePointInstanceView `json:"diskRestorePoints,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
RestorePointProperties the restore point properties.
type RestorePointProperties struct {
// ExcludeDisks - List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
ExcludeDisks *[]APIEntityReference `json:"excludeDisks,omitempty"`
// SourceMetadata - READ-ONLY; Gets the details of the VM captured at the time of the restore point creation.
SourceMetadata *RestorePointSourceMetadata `json:"sourceMetadata,omitempty"`
// ProvisioningState - READ-ONLY; Gets the provisioning state of the restore point.
ProvisioningState *string `json:"provisioningState,omitempty"`
// ConsistencyMode - READ-ONLY; Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. Possible values include: 'ConsistencyModeTypesCrashConsistent', 'ConsistencyModeTypesFileSystemConsistent', 'ConsistencyModeTypesApplicationConsistent'
ConsistencyMode ConsistencyModeTypes `json:"consistencyMode,omitempty"`
// TimeCreated - Gets the creation time of the restore point.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// SourceRestorePoint - Resource Id of the source restore point from which a copy needs to be created.
SourceRestorePoint *APIEntityReference `json:"sourceRestorePoint,omitempty"`
// InstanceView - READ-ONLY; The restore point instance view.
InstanceView *RestorePointInstanceView `json:"instanceView,omitempty"`
}
func (rpp RestorePointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RestorePointProperties.
RestorePointSourceMetadata describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.
type RestorePointSourceMetadata struct {
// HardwareProfile - Gets the hardware profile.
HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`
// StorageProfile - Gets the storage profile.
StorageProfile *RestorePointSourceVMStorageProfile `json:"storageProfile,omitempty"`
// OsProfile - Gets the OS profile.
OsProfile *OSProfile `json:"osProfile,omitempty"`
// DiagnosticsProfile - Gets the diagnostics profile.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// LicenseType - Gets the license type, which is for bring your own license scenario.
LicenseType *string `json:"licenseType,omitempty"`
// VMID - Gets the virtual machine unique id.
VMID *string `json:"vmId,omitempty"`
// SecurityProfile - Gets the security profile.
SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
// Location - Location of the VM from which the restore point was created.
Location *string `json:"location,omitempty"`
}
RestorePointSourceVMDataDisk describes a data disk.
type RestorePointSourceVMDataDisk struct {
// Lun - Gets the logical unit number.
Lun *int32 `json:"lun,omitempty"`
// Name - Gets the disk name.
Name *string `json:"name,omitempty"`
// Caching - Gets the caching type. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - Gets the managed disk details
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
// DiskRestorePoint - Gets the disk restore point Id.
DiskRestorePoint *APIEntityReference `json:"diskRestorePoint,omitempty"`
}
RestorePointSourceVMOSDisk describes an Operating System disk.
type RestorePointSourceVMOSDisk struct {
// OsType - Gets the Operating System type. Possible values include: 'OperatingSystemTypeWindows', 'OperatingSystemTypeLinux'
OsType OperatingSystemType `json:"osType,omitempty"`
// EncryptionSettings - Gets the disk encryption settings.
EncryptionSettings *DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Name - Gets the disk name.
Name *string `json:"name,omitempty"`
// Caching - Gets the caching type. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Gets the disk size in GB.
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - Gets the managed disk details
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
// DiskRestorePoint - Gets the disk restore point Id.
DiskRestorePoint *APIEntityReference `json:"diskRestorePoint,omitempty"`
}
RestorePointSourceVMStorageProfile describes the storage profile.
type RestorePointSourceVMStorageProfile struct {
// OsDisk - Gets the OS disk of the VM captured at the time of the restore point creation.
OsDisk *RestorePointSourceVMOSDisk `json:"osDisk,omitempty"`
// DataDisks - Gets the data disks of the VM captured at the time of the restore point creation.
DataDisks *[]RestorePointSourceVMDataDisk `json:"dataDisks,omitempty"`
}
RestorePointsClient is the compute Client
type RestorePointsClient struct {
BaseClient
}
func NewRestorePointsClient(subscriptionID string) RestorePointsClient
NewRestorePointsClient creates an instance of the RestorePointsClient client.
func NewRestorePointsClientWithBaseURI(baseURI string, subscriptionID string) RestorePointsClient
NewRestorePointsClientWithBaseURI creates an instance of the RestorePointsClient 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 RestorePointsClient) Create(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string, parameters RestorePoint) (result RestorePointsCreateFuture, err error)
Create the operation to create the restore point. Updating properties of an existing restore point is not allowed Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection. restorePointName - the name of the restore point. parameters - parameters supplied to the Create restore point operation.
func (client RestorePointsClient) CreatePreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string, parameters RestorePoint) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client RestorePointsClient) CreateResponder(resp *http.Response) (result RestorePoint, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client RestorePointsClient) CreateSender(req *http.Request) (future RestorePointsCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client RestorePointsClient) Delete(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string) (result RestorePointsDeleteFuture, err error)
Delete the operation to delete the restore point. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the Restore Point Collection. restorePointName - the name of the restore point.
func (client RestorePointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RestorePointsClient) 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 RestorePointsClient) DeleteSender(req *http.Request) (future RestorePointsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RestorePointsClient) Get(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string, expand RestorePointExpandOptions) (result RestorePoint, err error)
Get the operation to get the restore point. Parameters: resourceGroupName - the name of the resource group. restorePointCollectionName - the name of the restore point collection. restorePointName - the name of the restore point. expand - the expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.
func (client RestorePointsClient) GetPreparer(ctx context.Context, resourceGroupName string, restorePointCollectionName string, restorePointName string, expand RestorePointExpandOptions) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RestorePointsClient) GetResponder(resp *http.Response) (result RestorePoint, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client RestorePointsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
RestorePointsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RestorePointsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RestorePointsClient) (RestorePoint, error)
}
func (future *RestorePointsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RestorePointsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RestorePointsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RestorePointsClient) (autorest.Response, error)
}
func (future *RestorePointsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RetrieveBootDiagnosticsDataResult the SAS URIs of the console screenshot and serial log blobs.
type RetrieveBootDiagnosticsDataResult struct {
autorest.Response `json:"-"`
// ConsoleScreenshotBlobURI - READ-ONLY; The console screenshot blob URI
ConsoleScreenshotBlobURI *string `json:"consoleScreenshotBlobUri,omitempty"`
// SerialConsoleLogBlobURI - READ-ONLY; The serial console log blob URI.
SerialConsoleLogBlobURI *string `json:"serialConsoleLogBlobUri,omitempty"`
}
func (rbddr RetrieveBootDiagnosticsDataResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RetrieveBootDiagnosticsDataResult.
RoleInstance ...
type RoleInstance struct {
autorest.Response `json:"-"`
// 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 - READ-ONLY; Resource Location.
Location *string `json:"location,omitempty"`
// Tags - READ-ONLY; Resource tags.
Tags map[string]*string `json:"tags"`
Sku *InstanceSku `json:"sku,omitempty"`
Properties *RoleInstanceProperties `json:"properties,omitempty"`
}
func (ri RoleInstance) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleInstance.
RoleInstanceInstanceView the instance view of the role instance.
type RoleInstanceInstanceView struct {
autorest.Response `json:"-"`
// PlatformUpdateDomain - READ-ONLY; The Update Domain.
PlatformUpdateDomain *int32 `json:"platformUpdateDomain,omitempty"`
// PlatformFaultDomain - READ-ONLY; The Fault Domain.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// PrivateID - READ-ONLY; Specifies a unique identifier generated internally for the cloud service associated with this role instance. <br /><br /> NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.
PrivateID *string `json:"privateId,omitempty"`
// Statuses - READ-ONLY
Statuses *[]ResourceInstanceViewStatus `json:"statuses,omitempty"`
}
func (riiv RoleInstanceInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleInstanceInstanceView.
RoleInstanceListResult ...
type RoleInstanceListResult struct {
autorest.Response `json:"-"`
Value *[]RoleInstance `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (rilr RoleInstanceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RoleInstanceListResultIterator provides access to a complete listing of RoleInstance values.
type RoleInstanceListResultIterator struct {
// contains filtered or unexported fields
}
func NewRoleInstanceListResultIterator(page RoleInstanceListResultPage) RoleInstanceListResultIterator
Creates a new instance of the RoleInstanceListResultIterator type.
func (iter *RoleInstanceListResultIterator) 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 *RoleInstanceListResultIterator) 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 RoleInstanceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RoleInstanceListResultIterator) Response() RoleInstanceListResult
Response returns the raw server response from the last page request.
func (iter RoleInstanceListResultIterator) Value() RoleInstance
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RoleInstanceListResultPage contains a page of RoleInstance values.
type RoleInstanceListResultPage struct {
// contains filtered or unexported fields
}
func NewRoleInstanceListResultPage(cur RoleInstanceListResult, getNextPage func(context.Context, RoleInstanceListResult) (RoleInstanceListResult, error)) RoleInstanceListResultPage
Creates a new instance of the RoleInstanceListResultPage type.
func (page *RoleInstanceListResultPage) 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 *RoleInstanceListResultPage) 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 RoleInstanceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RoleInstanceListResultPage) Response() RoleInstanceListResult
Response returns the raw server response from the last page request.
func (page RoleInstanceListResultPage) Values() []RoleInstance
Values returns the slice of values for the current page or nil if there are no values.
RoleInstanceNetworkProfile describes the network profile for the role instance.
type RoleInstanceNetworkProfile struct {
// NetworkInterfaces - READ-ONLY; Specifies the list of resource Ids for the network interfaces associated with the role instance.
NetworkInterfaces *[]SubResource `json:"networkInterfaces,omitempty"`
}
func (rinp RoleInstanceNetworkProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoleInstanceNetworkProfile.
RoleInstanceProperties ...
type RoleInstanceProperties struct {
NetworkProfile *RoleInstanceNetworkProfile `json:"networkProfile,omitempty"`
InstanceView *RoleInstanceInstanceView `json:"instanceView,omitempty"`
}
RoleInstances specifies a list of role instances from the cloud service.
type RoleInstances struct {
// RoleInstances - List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.
RoleInstances *[]string `json:"roleInstances,omitempty"`
}
RollbackStatusInfo information about rollback on failed VM instances after a OS Upgrade operation.
type RollbackStatusInfo struct {
// SuccessfullyRolledbackInstanceCount - READ-ONLY; The number of instances which have been successfully rolled back.
SuccessfullyRolledbackInstanceCount *int32 `json:"successfullyRolledbackInstanceCount,omitempty"`
// FailedRolledbackInstanceCount - READ-ONLY; The number of instances which failed to rollback.
FailedRolledbackInstanceCount *int32 `json:"failedRolledbackInstanceCount,omitempty"`
// RollbackError - READ-ONLY; Error details if OS rollback failed.
RollbackError *APIError `json:"rollbackError,omitempty"`
}
func (rsi RollbackStatusInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollbackStatusInfo.
RollingUpgradeActionType enumerates the values for rolling upgrade action type.
type RollingUpgradeActionType string
const (
// RollingUpgradeActionTypeCancel ...
RollingUpgradeActionTypeCancel RollingUpgradeActionType = "Cancel"
// RollingUpgradeActionTypeStart ...
RollingUpgradeActionTypeStart RollingUpgradeActionType = "Start"
)
func PossibleRollingUpgradeActionTypeValues() []RollingUpgradeActionType
PossibleRollingUpgradeActionTypeValues returns an array of possible values for the RollingUpgradeActionType const type.
RollingUpgradePolicy the configuration parameters used while performing a rolling upgrade.
type RollingUpgradePolicy struct {
// MaxBatchInstancePercent - The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
MaxBatchInstancePercent *int32 `json:"maxBatchInstancePercent,omitempty"`
// MaxUnhealthyInstancePercent - The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
MaxUnhealthyInstancePercent *int32 `json:"maxUnhealthyInstancePercent,omitempty"`
// MaxUnhealthyUpgradedInstancePercent - The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
MaxUnhealthyUpgradedInstancePercent *int32 `json:"maxUnhealthyUpgradedInstancePercent,omitempty"`
// PauseTimeBetweenBatches - The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
PauseTimeBetweenBatches *string `json:"pauseTimeBetweenBatches,omitempty"`
// EnableCrossZoneUpgrade - Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
EnableCrossZoneUpgrade *bool `json:"enableCrossZoneUpgrade,omitempty"`
// PrioritizeUnhealthyInstances - Upgrade all unhealthy instances in a scale set before any healthy instances.
PrioritizeUnhealthyInstances *bool `json:"prioritizeUnhealthyInstances,omitempty"`
}
RollingUpgradeProgressInfo information about the number of virtual machine instances in each upgrade state.
type RollingUpgradeProgressInfo struct {
// SuccessfulInstanceCount - READ-ONLY; The number of instances that have been successfully upgraded.
SuccessfulInstanceCount *int32 `json:"successfulInstanceCount,omitempty"`
// FailedInstanceCount - READ-ONLY; The number of instances that have failed to be upgraded successfully.
FailedInstanceCount *int32 `json:"failedInstanceCount,omitempty"`
// InProgressInstanceCount - READ-ONLY; The number of instances that are currently being upgraded.
InProgressInstanceCount *int32 `json:"inProgressInstanceCount,omitempty"`
// PendingInstanceCount - READ-ONLY; The number of instances that have not yet begun to be upgraded.
PendingInstanceCount *int32 `json:"pendingInstanceCount,omitempty"`
}
func (rupi RollingUpgradeProgressInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeProgressInfo.
RollingUpgradeRunningStatus information about the current running state of the overall upgrade.
type RollingUpgradeRunningStatus struct {
// Code - READ-ONLY; Code indicating the current status of the upgrade. Possible values include: 'RollingUpgradeStatusCodeRollingForward', 'RollingUpgradeStatusCodeCancelled', 'RollingUpgradeStatusCodeCompleted', 'RollingUpgradeStatusCodeFaulted'
Code RollingUpgradeStatusCode `json:"code,omitempty"`
// StartTime - READ-ONLY; Start time of the upgrade.
StartTime *date.Time `json:"startTime,omitempty"`
// LastAction - READ-ONLY; The last action performed on the rolling upgrade. Possible values include: 'RollingUpgradeActionTypeStart', 'RollingUpgradeActionTypeCancel'
LastAction RollingUpgradeActionType `json:"lastAction,omitempty"`
// LastActionTime - READ-ONLY; Last action time of the upgrade.
LastActionTime *date.Time `json:"lastActionTime,omitempty"`
}
func (rurs RollingUpgradeRunningStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeRunningStatus.
RollingUpgradeStatusCode enumerates the values for rolling upgrade status code.
type RollingUpgradeStatusCode string
const (
// RollingUpgradeStatusCodeCancelled ...
RollingUpgradeStatusCodeCancelled RollingUpgradeStatusCode = "Cancelled"
// RollingUpgradeStatusCodeCompleted ...
RollingUpgradeStatusCodeCompleted RollingUpgradeStatusCode = "Completed"
// RollingUpgradeStatusCodeFaulted ...
RollingUpgradeStatusCodeFaulted RollingUpgradeStatusCode = "Faulted"
// RollingUpgradeStatusCodeRollingForward ...
RollingUpgradeStatusCodeRollingForward RollingUpgradeStatusCode = "RollingForward"
)
func PossibleRollingUpgradeStatusCodeValues() []RollingUpgradeStatusCode
PossibleRollingUpgradeStatusCodeValues returns an array of possible values for the RollingUpgradeStatusCode const type.
RollingUpgradeStatusInfo the status of the latest virtual machine scale set rolling upgrade.
type RollingUpgradeStatusInfo struct {
autorest.Response `json:"-"`
*RollingUpgradeStatusInfoProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (rusi RollingUpgradeStatusInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeStatusInfo.
func (rusi *RollingUpgradeStatusInfo) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RollingUpgradeStatusInfo struct.
RollingUpgradeStatusInfoProperties the status of the latest virtual machine scale set rolling upgrade.
type RollingUpgradeStatusInfoProperties struct {
// Policy - READ-ONLY; The rolling upgrade policies applied for this upgrade.
Policy *RollingUpgradePolicy `json:"policy,omitempty"`
// RunningStatus - READ-ONLY; Information about the current running state of the overall upgrade.
RunningStatus *RollingUpgradeRunningStatus `json:"runningStatus,omitempty"`
// Progress - READ-ONLY; Information about the number of virtual machine instances in each upgrade state.
Progress *RollingUpgradeProgressInfo `json:"progress,omitempty"`
// Error - READ-ONLY; Error details for this upgrade, if there are any.
Error *APIError `json:"error,omitempty"`
}
func (rusip RollingUpgradeStatusInfoProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RollingUpgradeStatusInfoProperties.
RunCommandDocument describes the properties of a Run Command.
type RunCommandDocument struct {
autorest.Response `json:"-"`
// Script - The script to be executed.
Script *[]string `json:"script,omitempty"`
// Parameters - The parameters used by the script.
Parameters *[]RunCommandParameterDefinition `json:"parameters,omitempty"`
// Schema - The VM run command schema.
Schema *string `json:"$schema,omitempty"`
// ID - The VM run command id.
ID *string `json:"id,omitempty"`
// OsType - The Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// Label - The VM run command label.
Label *string `json:"label,omitempty"`
// Description - The VM run command description.
Description *string `json:"description,omitempty"`
}
RunCommandDocumentBase describes the properties of a Run Command metadata.
type RunCommandDocumentBase struct {
// Schema - The VM run command schema.
Schema *string `json:"$schema,omitempty"`
// ID - The VM run command id.
ID *string `json:"id,omitempty"`
// OsType - The Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// Label - The VM run command label.
Label *string `json:"label,omitempty"`
// Description - The VM run command description.
Description *string `json:"description,omitempty"`
}
RunCommandInput capture Virtual Machine parameters.
type RunCommandInput struct {
// CommandID - The run command id.
CommandID *string `json:"commandId,omitempty"`
// Script - Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
Script *[]string `json:"script,omitempty"`
// Parameters - The run command parameters.
Parameters *[]RunCommandInputParameter `json:"parameters,omitempty"`
}
RunCommandInputParameter describes the properties of a run command parameter.
type RunCommandInputParameter struct {
// Name - The run command parameter name.
Name *string `json:"name,omitempty"`
// Value - The run command parameter value.
Value *string `json:"value,omitempty"`
}
RunCommandListResult the List Virtual Machine operation response.
type RunCommandListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine run commands.
Value *[]RunCommandDocumentBase `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.
NextLink *string `json:"nextLink,omitempty"`
}
func (rclr RunCommandListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RunCommandListResultIterator provides access to a complete listing of RunCommandDocumentBase values.
type RunCommandListResultIterator struct {
// contains filtered or unexported fields
}
func NewRunCommandListResultIterator(page RunCommandListResultPage) RunCommandListResultIterator
Creates a new instance of the RunCommandListResultIterator type.
func (iter *RunCommandListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RunCommandListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RunCommandListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RunCommandListResultIterator) Response() RunCommandListResult
Response returns the raw server response from the last page request.
func (iter RunCommandListResultIterator) Value() RunCommandDocumentBase
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RunCommandListResultPage contains a page of RunCommandDocumentBase values.
type RunCommandListResultPage struct {
// contains filtered or unexported fields
}
func NewRunCommandListResultPage(cur RunCommandListResult, getNextPage func(context.Context, RunCommandListResult) (RunCommandListResult, error)) RunCommandListResultPage
Creates a new instance of the RunCommandListResultPage type.
func (page *RunCommandListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RunCommandListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RunCommandListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RunCommandListResultPage) Response() RunCommandListResult
Response returns the raw server response from the last page request.
func (page RunCommandListResultPage) Values() []RunCommandDocumentBase
Values returns the slice of values for the current page or nil if there are no values.
RunCommandParameterDefinition describes the properties of a run command parameter.
type RunCommandParameterDefinition struct {
// Name - The run command parameter name.
Name *string `json:"name,omitempty"`
// Type - The run command parameter type.
Type *string `json:"type,omitempty"`
// DefaultValue - The run command parameter default value.
DefaultValue *string `json:"defaultValue,omitempty"`
// Required - The run command parameter required.
Required *bool `json:"required,omitempty"`
}
RunCommandResult ...
type RunCommandResult struct {
autorest.Response `json:"-"`
// Value - Run command operation response.
Value *[]InstanceViewStatus `json:"value,omitempty"`
}
SSHConfiguration SSH configuration for Linux based VMs running on Azure
type SSHConfiguration struct {
// PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys *[]SSHPublicKey `json:"publicKeys,omitempty"`
}
SSHPublicKey contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
type SSHPublicKey struct {
// Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
Path *string `json:"path,omitempty"`
// KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
KeyData *string `json:"keyData,omitempty"`
}
SSHPublicKeyGenerateKeyPairResult response from generation of an SSH key pair.
type SSHPublicKeyGenerateKeyPairResult struct {
autorest.Response `json:"-"`
// PrivateKey - Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret.
PrivateKey *string `json:"privateKey,omitempty"`
// PublicKey - Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format.
PublicKey *string `json:"publicKey,omitempty"`
// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}
ID *string `json:"id,omitempty"`
}
SSHPublicKeyResource specifies information about the SSH public key.
type SSHPublicKeyResource struct {
autorest.Response `json:"-"`
// SSHPublicKeyResourceProperties - Properties of the SSH public key.
*SSHPublicKeyResourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (spkr SSHPublicKeyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SSHPublicKeyResource.
func (spkr *SSHPublicKeyResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SSHPublicKeyResource struct.
SSHPublicKeyResourceProperties properties of the SSH public key.
type SSHPublicKeyResourceProperties struct {
// PublicKey - SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
PublicKey *string `json:"publicKey,omitempty"`
}
SSHPublicKeyUpdateResource specifies information about the SSH public key.
type SSHPublicKeyUpdateResource struct {
// SSHPublicKeyResourceProperties - Properties of the SSH public key.
*SSHPublicKeyResourceProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (spkur SSHPublicKeyUpdateResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SSHPublicKeyUpdateResource.
func (spkur *SSHPublicKeyUpdateResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SSHPublicKeyUpdateResource struct.
SSHPublicKeysClient is the compute Client
type SSHPublicKeysClient struct {
BaseClient
}
func NewSSHPublicKeysClient(subscriptionID string) SSHPublicKeysClient
NewSSHPublicKeysClient creates an instance of the SSHPublicKeysClient client.
func NewSSHPublicKeysClientWithBaseURI(baseURI string, subscriptionID string) SSHPublicKeysClient
NewSSHPublicKeysClientWithBaseURI creates an instance of the SSHPublicKeysClient 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 SSHPublicKeysClient) Create(ctx context.Context, resourceGroupName string, SSHPublicKeyName string, parameters SSHPublicKeyResource) (result SSHPublicKeyResource, err error)
Create creates a new SSH public key resource. Parameters: resourceGroupName - the name of the resource group. SSHPublicKeyName - the name of the SSH public key. parameters - parameters supplied to create the SSH public key.
func (client SSHPublicKeysClient) CreatePreparer(ctx context.Context, resourceGroupName string, SSHPublicKeyName string, parameters SSHPublicKeyResource) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client SSHPublicKeysClient) CreateResponder(resp *http.Response) (result SSHPublicKeyResource, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client SSHPublicKeysClient) Delete(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (result autorest.Response, err error)
Delete delete an SSH public key. Parameters: resourceGroupName - the name of the resource group. SSHPublicKeyName - the name of the SSH public key.
func (client SSHPublicKeysClient) DeletePreparer(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SSHPublicKeysClient) 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 SSHPublicKeysClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SSHPublicKeysClient) GenerateKeyPair(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (result SSHPublicKeyGenerateKeyPairResult, err error)
GenerateKeyPair generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource. Parameters: resourceGroupName - the name of the resource group. SSHPublicKeyName - the name of the SSH public key.
func (client SSHPublicKeysClient) GenerateKeyPairPreparer(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (*http.Request, error)
GenerateKeyPairPreparer prepares the GenerateKeyPair request.
func (client SSHPublicKeysClient) GenerateKeyPairResponder(resp *http.Response) (result SSHPublicKeyGenerateKeyPairResult, err error)
GenerateKeyPairResponder handles the response to the GenerateKeyPair request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) GenerateKeyPairSender(req *http.Request) (*http.Response, error)
GenerateKeyPairSender sends the GenerateKeyPair request. The method will close the http.Response Body if it receives an error.
func (client SSHPublicKeysClient) Get(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (result SSHPublicKeyResource, err error)
Get retrieves information about an SSH public key. Parameters: resourceGroupName - the name of the resource group. SSHPublicKeyName - the name of the SSH public key.
func (client SSHPublicKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, SSHPublicKeyName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SSHPublicKeysClient) GetResponder(resp *http.Response) (result SSHPublicKeyResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SSHPublicKeysClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result SSHPublicKeysGroupListResultPage, err error)
ListByResourceGroup lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys. Parameters: resourceGroupName - the name of the resource group.
func (client SSHPublicKeysClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result SSHPublicKeysGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SSHPublicKeysClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client SSHPublicKeysClient) ListByResourceGroupResponder(resp *http.Response) (result SSHPublicKeysGroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) 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 SSHPublicKeysClient) ListBySubscription(ctx context.Context) (result SSHPublicKeysGroupListResultPage, err error)
ListBySubscription lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.
func (client SSHPublicKeysClient) ListBySubscriptionComplete(ctx context.Context) (result SSHPublicKeysGroupListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client SSHPublicKeysClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client SSHPublicKeysClient) ListBySubscriptionResponder(resp *http.Response) (result SSHPublicKeysGroupListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) 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 SSHPublicKeysClient) Update(ctx context.Context, resourceGroupName string, SSHPublicKeyName string, parameters SSHPublicKeyUpdateResource) (result SSHPublicKeyResource, err error)
Update updates a new SSH public key resource. Parameters: resourceGroupName - the name of the resource group. SSHPublicKeyName - the name of the SSH public key. parameters - parameters supplied to update the SSH public key.
func (client SSHPublicKeysClient) UpdatePreparer(ctx context.Context, resourceGroupName string, SSHPublicKeyName string, parameters SSHPublicKeyUpdateResource) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SSHPublicKeysClient) UpdateResponder(resp *http.Response) (result SSHPublicKeyResource, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SSHPublicKeysClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SSHPublicKeysGroupListResult the list SSH public keys operation response.
type SSHPublicKeysGroupListResult struct {
autorest.Response `json:"-"`
// Value - The list of SSH public keys
Value *[]SSHPublicKeyResource `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys.
NextLink *string `json:"nextLink,omitempty"`
}
func (spkglr SSHPublicKeysGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SSHPublicKeysGroupListResultIterator provides access to a complete listing of SSHPublicKeyResource values.
type SSHPublicKeysGroupListResultIterator struct {
// contains filtered or unexported fields
}
func NewSSHPublicKeysGroupListResultIterator(page SSHPublicKeysGroupListResultPage) SSHPublicKeysGroupListResultIterator
Creates a new instance of the SSHPublicKeysGroupListResultIterator type.
func (iter *SSHPublicKeysGroupListResultIterator) 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 *SSHPublicKeysGroupListResultIterator) 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 SSHPublicKeysGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SSHPublicKeysGroupListResultIterator) Response() SSHPublicKeysGroupListResult
Response returns the raw server response from the last page request.
func (iter SSHPublicKeysGroupListResultIterator) Value() SSHPublicKeyResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SSHPublicKeysGroupListResultPage contains a page of SSHPublicKeyResource values.
type SSHPublicKeysGroupListResultPage struct {
// contains filtered or unexported fields
}
func NewSSHPublicKeysGroupListResultPage(cur SSHPublicKeysGroupListResult, getNextPage func(context.Context, SSHPublicKeysGroupListResult) (SSHPublicKeysGroupListResult, error)) SSHPublicKeysGroupListResultPage
Creates a new instance of the SSHPublicKeysGroupListResultPage type.
func (page *SSHPublicKeysGroupListResultPage) 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 *SSHPublicKeysGroupListResultPage) 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 SSHPublicKeysGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SSHPublicKeysGroupListResultPage) Response() SSHPublicKeysGroupListResult
Response returns the raw server response from the last page request.
func (page SSHPublicKeysGroupListResultPage) Values() []SSHPublicKeyResource
Values returns the slice of values for the current page or nil if there are no values.
ScaleInPolicy describes a scale-in policy for a virtual machine scale set.
type ScaleInPolicy struct {
// Rules - The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br>
Rules *[]VirtualMachineScaleSetScaleInRules `json:"rules,omitempty"`
// ForceDeletion - This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)
ForceDeletion *bool `json:"forceDeletion,omitempty"`
}
ScheduledEventsProfile ...
type ScheduledEventsProfile struct {
// TerminateNotificationProfile - Specifies Terminate Scheduled Event related configurations.
TerminateNotificationProfile *TerminateNotificationProfile `json:"terminateNotificationProfile,omitempty"`
}
SecurityEncryptionTypes enumerates the values for security encryption types.
type SecurityEncryptionTypes string
const (
// SecurityEncryptionTypesDiskWithVMGuestState ...
SecurityEncryptionTypesDiskWithVMGuestState SecurityEncryptionTypes = "DiskWithVMGuestState"
// SecurityEncryptionTypesVMGuestStateOnly ...
SecurityEncryptionTypesVMGuestStateOnly SecurityEncryptionTypes = "VMGuestStateOnly"
)
func PossibleSecurityEncryptionTypesValues() []SecurityEncryptionTypes
PossibleSecurityEncryptionTypesValues returns an array of possible values for the SecurityEncryptionTypes const type.
SecurityProfile specifies the Security profile settings for the virtual machine or virtual machine scale set.
type SecurityProfile struct {
// UefiSettings - Specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01
UefiSettings *UefiSettings `json:"uefiSettings,omitempty"`
// EncryptionAtHost - This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. <br><br> Default: The Encryption at host will be disabled unless this property is set to true for the resource.
EncryptionAtHost *bool `json:"encryptionAtHost,omitempty"`
// SecurityType - Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. <br><br> Default: UefiSettings will not be enabled unless this property is set. Possible values include: 'SecurityTypesTrustedLaunch', 'SecurityTypesConfidentialVM'
SecurityType SecurityTypes `json:"securityType,omitempty"`
}
SecurityTypes enumerates the values for security types.
type SecurityTypes string
const (
// SecurityTypesConfidentialVM ...
SecurityTypesConfidentialVM SecurityTypes = "ConfidentialVM"
// SecurityTypesTrustedLaunch ...
SecurityTypesTrustedLaunch SecurityTypes = "TrustedLaunch"
)
func PossibleSecurityTypesValues() []SecurityTypes
PossibleSecurityTypesValues returns an array of possible values for the SecurityTypes const type.
SelectPermissions enumerates the values for select permissions.
type SelectPermissions string
const (
// SelectPermissionsPermissions ...
SelectPermissionsPermissions SelectPermissions = "Permissions"
)
func PossibleSelectPermissionsValues() []SelectPermissions
PossibleSelectPermissionsValues returns an array of possible values for the SelectPermissions const type.
SettingNames enumerates the values for setting names.
type SettingNames string
const (
// SettingNamesAutoLogon ...
SettingNamesAutoLogon SettingNames = "AutoLogon"
// SettingNamesFirstLogonCommands ...
SettingNamesFirstLogonCommands SettingNames = "FirstLogonCommands"
)
func PossibleSettingNamesValues() []SettingNames
PossibleSettingNamesValues returns an array of possible values for the SettingNames const type.
ShareInfoElement ...
type ShareInfoElement struct {
// VMURI - READ-ONLY; A relative URI containing the ID of the VM that has the disk attached.
VMURI *string `json:"vmUri,omitempty"`
}
func (sie ShareInfoElement) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ShareInfoElement.
SharedGalleriesClient is the compute Client
type SharedGalleriesClient struct {
BaseClient
}
func NewSharedGalleriesClient(subscriptionID string) SharedGalleriesClient
NewSharedGalleriesClient creates an instance of the SharedGalleriesClient client.
func NewSharedGalleriesClientWithBaseURI(baseURI string, subscriptionID string) SharedGalleriesClient
NewSharedGalleriesClientWithBaseURI creates an instance of the SharedGalleriesClient 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 SharedGalleriesClient) Get(ctx context.Context, location string, galleryUniqueName string) (result SharedGallery, err error)
Get get a shared gallery by subscription id or tenant id. Parameters: location - resource location. galleryUniqueName - the unique name of the Shared Gallery.
func (client SharedGalleriesClient) GetPreparer(ctx context.Context, location string, galleryUniqueName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SharedGalleriesClient) GetResponder(resp *http.Response) (result SharedGallery, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SharedGalleriesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SharedGalleriesClient) List(ctx context.Context, location string, sharedTo SharedToValues) (result SharedGalleryListPage, err error)
List list shared galleries by subscription id or tenant id. Parameters: location - resource location. sharedTo - the query parameter to decide what shared galleries to fetch when doing listing operations.
func (client SharedGalleriesClient) ListComplete(ctx context.Context, location string, sharedTo SharedToValues) (result SharedGalleryListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SharedGalleriesClient) ListPreparer(ctx context.Context, location string, sharedTo SharedToValues) (*http.Request, error)
ListPreparer prepares the List request.
func (client SharedGalleriesClient) ListResponder(resp *http.Response) (result SharedGalleryList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SharedGalleriesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
SharedGallery specifies information about the Shared Gallery that you want to create or update.
type SharedGallery struct {
autorest.Response `json:"-"`
*SharedGalleryIdentifier `json:"identifier,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (sg SharedGallery) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedGallery.
func (sg *SharedGallery) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SharedGallery struct.
SharedGalleryIdentifier the identifier information of shared gallery.
type SharedGalleryIdentifier struct {
// UniqueID - The unique id of this shared gallery.
UniqueID *string `json:"uniqueId,omitempty"`
}
SharedGalleryImage specifies information about the gallery image definition that you want to create or update.
type SharedGalleryImage struct {
autorest.Response `json:"-"`
*SharedGalleryImageProperties `json:"properties,omitempty"`
*SharedGalleryIdentifier `json:"identifier,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (sgi SharedGalleryImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedGalleryImage.
func (sgi *SharedGalleryImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SharedGalleryImage struct.
SharedGalleryImageList the List Shared Gallery Images operation response.
type SharedGalleryImageList struct {
autorest.Response `json:"-"`
// Value - A list of shared gallery images.
Value *[]SharedGalleryImage `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images.
NextLink *string `json:"nextLink,omitempty"`
}
func (sgil SharedGalleryImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SharedGalleryImageListIterator provides access to a complete listing of SharedGalleryImage values.
type SharedGalleryImageListIterator struct {
// contains filtered or unexported fields
}
func NewSharedGalleryImageListIterator(page SharedGalleryImageListPage) SharedGalleryImageListIterator
Creates a new instance of the SharedGalleryImageListIterator type.
func (iter *SharedGalleryImageListIterator) 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 *SharedGalleryImageListIterator) 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 SharedGalleryImageListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedGalleryImageListIterator) Response() SharedGalleryImageList
Response returns the raw server response from the last page request.
func (iter SharedGalleryImageListIterator) Value() SharedGalleryImage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SharedGalleryImageListPage contains a page of SharedGalleryImage values.
type SharedGalleryImageListPage struct {
// contains filtered or unexported fields
}
func NewSharedGalleryImageListPage(cur SharedGalleryImageList, getNextPage func(context.Context, SharedGalleryImageList) (SharedGalleryImageList, error)) SharedGalleryImageListPage
Creates a new instance of the SharedGalleryImageListPage type.
func (page *SharedGalleryImageListPage) 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 *SharedGalleryImageListPage) 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 SharedGalleryImageListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedGalleryImageListPage) Response() SharedGalleryImageList
Response returns the raw server response from the last page request.
func (page SharedGalleryImageListPage) Values() []SharedGalleryImage
Values returns the slice of values for the current page or nil if there are no values.
SharedGalleryImageProperties describes the properties of a gallery image definition.
type SharedGalleryImageProperties struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Possible values include: 'OperatingSystemStateTypesGeneralized', 'OperatingSystemStateTypesSpecialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// EndOfLifeDate - The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
Identifier *GalleryImageIdentifier `json:"identifier,omitempty"`
Recommended *RecommendedMachineConfiguration `json:"recommended,omitempty"`
Disallowed *Disallowed `json:"disallowed,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// Features - A list of gallery image features.
Features *[]GalleryImageFeature `json:"features,omitempty"`
PurchasePlan *ImagePurchasePlan `json:"purchasePlan,omitempty"`
}
SharedGalleryImageVersion specifies information about the gallery image version that you want to create or update.
type SharedGalleryImageVersion struct {
autorest.Response `json:"-"`
*SharedGalleryImageVersionProperties `json:"properties,omitempty"`
*SharedGalleryIdentifier `json:"identifier,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (sgiv SharedGalleryImageVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedGalleryImageVersion.
func (sgiv *SharedGalleryImageVersion) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SharedGalleryImageVersion struct.
SharedGalleryImageVersionList the List Shared Gallery Image versions operation response.
type SharedGalleryImageVersionList struct {
autorest.Response `json:"-"`
// Value - A list of shared gallery images versions.
Value *[]SharedGalleryImageVersion `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions.
NextLink *string `json:"nextLink,omitempty"`
}
func (sgivl SharedGalleryImageVersionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SharedGalleryImageVersionListIterator provides access to a complete listing of SharedGalleryImageVersion values.
type SharedGalleryImageVersionListIterator struct {
// contains filtered or unexported fields
}
func NewSharedGalleryImageVersionListIterator(page SharedGalleryImageVersionListPage) SharedGalleryImageVersionListIterator
Creates a new instance of the SharedGalleryImageVersionListIterator type.
func (iter *SharedGalleryImageVersionListIterator) 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 *SharedGalleryImageVersionListIterator) 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 SharedGalleryImageVersionListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedGalleryImageVersionListIterator) Response() SharedGalleryImageVersionList
Response returns the raw server response from the last page request.
func (iter SharedGalleryImageVersionListIterator) Value() SharedGalleryImageVersion
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SharedGalleryImageVersionListPage contains a page of SharedGalleryImageVersion values.
type SharedGalleryImageVersionListPage struct {
// contains filtered or unexported fields
}
func NewSharedGalleryImageVersionListPage(cur SharedGalleryImageVersionList, getNextPage func(context.Context, SharedGalleryImageVersionList) (SharedGalleryImageVersionList, error)) SharedGalleryImageVersionListPage
Creates a new instance of the SharedGalleryImageVersionListPage type.
func (page *SharedGalleryImageVersionListPage) 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 *SharedGalleryImageVersionListPage) 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 SharedGalleryImageVersionListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedGalleryImageVersionListPage) Response() SharedGalleryImageVersionList
Response returns the raw server response from the last page request.
func (page SharedGalleryImageVersionListPage) Values() []SharedGalleryImageVersion
Values returns the slice of values for the current page or nil if there are no values.
SharedGalleryImageVersionProperties describes the properties of a gallery image version.
type SharedGalleryImageVersionProperties struct {
// PublishedDate - The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
PublishedDate *date.Time `json:"publishedDate,omitempty"`
// EndOfLifeDate - The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
}
SharedGalleryImageVersionsClient is the compute Client
type SharedGalleryImageVersionsClient struct {
BaseClient
}
func NewSharedGalleryImageVersionsClient(subscriptionID string) SharedGalleryImageVersionsClient
NewSharedGalleryImageVersionsClient creates an instance of the SharedGalleryImageVersionsClient client.
func NewSharedGalleryImageVersionsClientWithBaseURI(baseURI string, subscriptionID string) SharedGalleryImageVersionsClient
NewSharedGalleryImageVersionsClientWithBaseURI creates an instance of the SharedGalleryImageVersionsClient 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 SharedGalleryImageVersionsClient) Get(ctx context.Context, location string, galleryUniqueName string, galleryImageName string, galleryImageVersionName string) (result SharedGalleryImageVersion, err error)
Get get a shared gallery image version by subscription id or tenant id. Parameters: location - resource location. galleryUniqueName - the unique name of the Shared Gallery. galleryImageName - the name of the Shared Gallery Image Definition from which the Image Versions are to be listed. galleryImageVersionName - the name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch>
func (client SharedGalleryImageVersionsClient) GetPreparer(ctx context.Context, location string, galleryUniqueName string, galleryImageName string, galleryImageVersionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SharedGalleryImageVersionsClient) GetResponder(resp *http.Response) (result SharedGalleryImageVersion, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SharedGalleryImageVersionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SharedGalleryImageVersionsClient) List(ctx context.Context, location string, galleryUniqueName string, galleryImageName string, sharedTo SharedToValues) (result SharedGalleryImageVersionListPage, err error)
List list shared gallery image versions by subscription id or tenant id. Parameters: location - resource location. galleryUniqueName - the unique name of the Shared Gallery. galleryImageName - the name of the Shared Gallery Image Definition from which the Image Versions are to be listed. sharedTo - the query parameter to decide what shared galleries to fetch when doing listing operations.
func (client SharedGalleryImageVersionsClient) ListComplete(ctx context.Context, location string, galleryUniqueName string, galleryImageName string, sharedTo SharedToValues) (result SharedGalleryImageVersionListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SharedGalleryImageVersionsClient) ListPreparer(ctx context.Context, location string, galleryUniqueName string, galleryImageName string, sharedTo SharedToValues) (*http.Request, error)
ListPreparer prepares the List request.
func (client SharedGalleryImageVersionsClient) ListResponder(resp *http.Response) (result SharedGalleryImageVersionList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SharedGalleryImageVersionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
SharedGalleryImagesClient is the compute Client
type SharedGalleryImagesClient struct {
BaseClient
}
func NewSharedGalleryImagesClient(subscriptionID string) SharedGalleryImagesClient
NewSharedGalleryImagesClient creates an instance of the SharedGalleryImagesClient client.
func NewSharedGalleryImagesClientWithBaseURI(baseURI string, subscriptionID string) SharedGalleryImagesClient
NewSharedGalleryImagesClientWithBaseURI creates an instance of the SharedGalleryImagesClient 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 SharedGalleryImagesClient) Get(ctx context.Context, location string, galleryUniqueName string, galleryImageName string) (result SharedGalleryImage, err error)
Get get a shared gallery image by subscription id or tenant id. Parameters: location - resource location. galleryUniqueName - the unique name of the Shared Gallery. galleryImageName - the name of the Shared Gallery Image Definition from which the Image Versions are to be listed.
func (client SharedGalleryImagesClient) GetPreparer(ctx context.Context, location string, galleryUniqueName string, galleryImageName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SharedGalleryImagesClient) GetResponder(resp *http.Response) (result SharedGalleryImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SharedGalleryImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SharedGalleryImagesClient) List(ctx context.Context, location string, galleryUniqueName string, sharedTo SharedToValues) (result SharedGalleryImageListPage, err error)
List list shared gallery images by subscription id or tenant id. Parameters: location - resource location. galleryUniqueName - the unique name of the Shared Gallery. sharedTo - the query parameter to decide what shared galleries to fetch when doing listing operations.
func (client SharedGalleryImagesClient) ListComplete(ctx context.Context, location string, galleryUniqueName string, sharedTo SharedToValues) (result SharedGalleryImageListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SharedGalleryImagesClient) ListPreparer(ctx context.Context, location string, galleryUniqueName string, sharedTo SharedToValues) (*http.Request, error)
ListPreparer prepares the List request.
func (client SharedGalleryImagesClient) ListResponder(resp *http.Response) (result SharedGalleryImageList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SharedGalleryImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
SharedGalleryList the List Shared Galleries operation response.
type SharedGalleryList struct {
autorest.Response `json:"-"`
// Value - A list of shared galleries.
Value *[]SharedGallery `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries.
NextLink *string `json:"nextLink,omitempty"`
}
func (sgl SharedGalleryList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SharedGalleryListIterator provides access to a complete listing of SharedGallery values.
type SharedGalleryListIterator struct {
// contains filtered or unexported fields
}
func NewSharedGalleryListIterator(page SharedGalleryListPage) SharedGalleryListIterator
Creates a new instance of the SharedGalleryListIterator type.
func (iter *SharedGalleryListIterator) 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 *SharedGalleryListIterator) 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 SharedGalleryListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedGalleryListIterator) Response() SharedGalleryList
Response returns the raw server response from the last page request.
func (iter SharedGalleryListIterator) Value() SharedGallery
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SharedGalleryListPage contains a page of SharedGallery values.
type SharedGalleryListPage struct {
// contains filtered or unexported fields
}
func NewSharedGalleryListPage(cur SharedGalleryList, getNextPage func(context.Context, SharedGalleryList) (SharedGalleryList, error)) SharedGalleryListPage
Creates a new instance of the SharedGalleryListPage type.
func (page *SharedGalleryListPage) 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 *SharedGalleryListPage) 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 SharedGalleryListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedGalleryListPage) Response() SharedGalleryList
Response returns the raw server response from the last page request.
func (page SharedGalleryListPage) Values() []SharedGallery
Values returns the slice of values for the current page or nil if there are no values.
SharedToValues enumerates the values for shared to values.
type SharedToValues string
const (
// SharedToValuesTenant ...
SharedToValues = "tenant"
)
func PossibleSharedToValuesValues() []SharedToValues
PossibleSharedToValuesValues returns an array of possible values for the SharedToValues const type.
SharingProfile profile for gallery sharing to subscription or tenant
type SharingProfile struct {
// Permissions - This property allows you to specify the permission of sharing gallery. <br><br> Possible values are: <br><br> **Private** <br><br> **Groups**. Possible values include: 'GallerySharingPermissionTypesPrivate', 'GallerySharingPermissionTypesGroups'
Permissions GallerySharingPermissionTypes `json:"permissions,omitempty"`
// Groups - READ-ONLY; A list of sharing profile groups.
Groups *[]SharingProfileGroup `json:"groups,omitempty"`
// CommunityGalleryInfo - Information of community gallery if current gallery is shared to community.
CommunityGalleryInfo interface{} `json:"communityGalleryInfo,omitempty"`
}
func (sp SharingProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharingProfile.
SharingProfileGroup group of the gallery sharing profile
type SharingProfileGroup struct {
// Type - This property allows you to specify the type of sharing group. <br><br> Possible values are: <br><br> **Subscriptions** <br><br> **AADTenants** <br><br> **Community**. Possible values include: 'SharingProfileGroupTypesSubscriptions', 'SharingProfileGroupTypesAADTenants', 'SharingProfileGroupTypesCommunity'
Type SharingProfileGroupTypes `json:"type,omitempty"`
// Ids - A list of subscription/tenant ids the gallery is aimed to be shared to.
Ids *[]string `json:"ids,omitempty"`
}
SharingProfileGroupTypes enumerates the values for sharing profile group types.
type SharingProfileGroupTypes string
const (
// SharingProfileGroupTypesAADTenants ...
SharingProfileGroupTypesAADTenants SharingProfileGroupTypes = "AADTenants"
// SharingProfileGroupTypesCommunity ...
SharingProfileGroupTypesCommunity SharingProfileGroupTypes = "Community"
// SharingProfileGroupTypesSubscriptions ...
SharingProfileGroupTypesSubscriptions SharingProfileGroupTypes = "Subscriptions"
)
func PossibleSharingProfileGroupTypesValues() []SharingProfileGroupTypes
PossibleSharingProfileGroupTypesValues returns an array of possible values for the SharingProfileGroupTypes const type.
SharingState enumerates the values for sharing state.
type SharingState string
const (
// SharingStateFailed ...
SharingStateFailed SharingState = "Failed"
// SharingStateInProgress ...
SharingStateInProgress SharingState = "InProgress"
// SharingStateSucceeded ...
SharingStateSucceeded SharingState = "Succeeded"
// SharingStateUnknown ...
SharingStateUnknown SharingState = "Unknown"
)
func PossibleSharingStateValues() []SharingState
PossibleSharingStateValues returns an array of possible values for the SharingState const type.
SharingStatus sharing status of current gallery.
type SharingStatus struct {
// AggregatedState - Aggregated sharing state of current gallery. Possible values include: 'SharingStateSucceeded', 'SharingStateInProgress', 'SharingStateFailed', 'SharingStateUnknown'
AggregatedState SharingState `json:"aggregatedState,omitempty"`
// Summary - Summary of all regional sharing status.
Summary *[]RegionalSharingStatus `json:"summary,omitempty"`
}
SharingUpdate specifies information about the gallery sharing profile update.
type SharingUpdate struct {
autorest.Response `json:"-"`
// OperationType - This property allows you to specify the operation type of gallery sharing update. <br><br> Possible values are: <br><br> **Add** <br><br> **Remove** <br><br> **Reset**. Possible values include: 'SharingUpdateOperationTypesAdd', 'SharingUpdateOperationTypesRemove', 'SharingUpdateOperationTypesReset', 'SharingUpdateOperationTypesEnableCommunity'
OperationType SharingUpdateOperationTypes `json:"operationType,omitempty"`
// Groups - A list of sharing profile groups.
Groups *[]SharingProfileGroup `json:"groups,omitempty"`
}
SharingUpdateOperationTypes enumerates the values for sharing update operation types.
type SharingUpdateOperationTypes string
const (
// SharingUpdateOperationTypesAdd ...
SharingUpdateOperationTypesAdd SharingUpdateOperationTypes = "Add"
// SharingUpdateOperationTypesEnableCommunity ...
SharingUpdateOperationTypesEnableCommunity SharingUpdateOperationTypes = "EnableCommunity"
// SharingUpdateOperationTypesRemove ...
SharingUpdateOperationTypesRemove SharingUpdateOperationTypes = "Remove"
// SharingUpdateOperationTypesReset ...
SharingUpdateOperationTypesReset SharingUpdateOperationTypes = "Reset"
)
func PossibleSharingUpdateOperationTypesValues() []SharingUpdateOperationTypes
PossibleSharingUpdateOperationTypesValues returns an array of possible values for the SharingUpdateOperationTypes const type.
Sku describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
type Sku struct {
// Name - The sku name.
Name *string `json:"name,omitempty"`
// Tier - Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**
Tier *string `json:"tier,omitempty"`
// Capacity - Specifies the number of virtual machines in the scale set.
Capacity *int64 `json:"capacity,omitempty"`
}
Snapshot snapshot resource.
type Snapshot struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; Unused. Always Null.
ManagedBy *string `json:"managedBy,omitempty"`
Sku *SnapshotSku `json:"sku,omitempty"`
// ExtendedLocation - The extended location where the snapshot will be created. Extended location cannot be changed.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
*SnapshotProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (s Snapshot) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Snapshot.
func (s *Snapshot) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Snapshot struct.
SnapshotList the List Snapshots operation response.
type SnapshotList struct {
autorest.Response `json:"-"`
// Value - A list of snapshots.
Value *[]Snapshot `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots.
NextLink *string `json:"nextLink,omitempty"`
}
func (sl SnapshotList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SnapshotListIterator provides access to a complete listing of Snapshot values.
type SnapshotListIterator struct {
// contains filtered or unexported fields
}
func NewSnapshotListIterator(page SnapshotListPage) SnapshotListIterator
Creates a new instance of the SnapshotListIterator type.
func (iter *SnapshotListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SnapshotListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SnapshotListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SnapshotListIterator) Response() SnapshotList
Response returns the raw server response from the last page request.
func (iter SnapshotListIterator) Value() Snapshot
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SnapshotListPage contains a page of Snapshot values.
type SnapshotListPage struct {
// contains filtered or unexported fields
}
func NewSnapshotListPage(cur SnapshotList, getNextPage func(context.Context, SnapshotList) (SnapshotList, error)) SnapshotListPage
Creates a new instance of the SnapshotListPage type.
func (page *SnapshotListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SnapshotListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SnapshotListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SnapshotListPage) Response() SnapshotList
Response returns the raw server response from the last page request.
func (page SnapshotListPage) Values() []Snapshot
Values returns the slice of values for the current page or nil if there are no values.
SnapshotProperties snapshot resource properties.
type SnapshotProperties struct {
// TimeCreated - READ-ONLY; The time when the snapshot was created.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// OsType - The Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// HyperVGeneration - The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'HyperVGenerationV1', 'HyperVGenerationV2'
HyperVGeneration HyperVGeneration `json:"hyperVGeneration,omitempty"`
// PurchasePlan - Purchase plan information for the image from which the source disk for the snapshot was originally created.
PurchasePlan *PurchasePlan `json:"purchasePlan,omitempty"`
// SupportedCapabilities - List of supported capabilities for the image from which the source disk from the snapshot was originally created.
SupportedCapabilities *SupportedCapabilities `json:"supportedCapabilities,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"`
// DiskState - The state of the snapshot. Possible values include: 'DiskStateUnattached', 'DiskStateAttached', 'DiskStateReserved', 'DiskStateFrozen', 'DiskStateActiveSAS', 'DiskStateActiveSASFrozen', 'DiskStateReadyToUpload', 'DiskStateActiveUpload'
DiskState DiskState `json:"diskState,omitempty"`
// UniqueID - READ-ONLY; Unique Guid identifying the resource.
UniqueID *string `json:"uniqueId,omitempty"`
// EncryptionSettingsCollection - Encryption settings collection used be 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"`
// Incremental - Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
Incremental *bool `json:"incremental,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"`
// NetworkAccessPolicy - Possible values include: 'NetworkAccessPolicyAllowAll', 'NetworkAccessPolicyAllowPrivate', 'NetworkAccessPolicyDenyAll'
NetworkAccessPolicy NetworkAccessPolicy `json:"networkAccessPolicy,omitempty"`
// DiskAccessID - ARM id of the DiskAccess resource for using private endpoints on disks.
DiskAccessID *string `json:"diskAccessId,omitempty"`
// SecurityProfile - Contains the security related information for the resource.
SecurityProfile *DiskSecurityProfile `json:"securityProfile,omitempty"`
// SupportsHibernation - Indicates the OS on a snapshot supports hibernation.
SupportsHibernation *bool `json:"supportsHibernation,omitempty"`
// PublicNetworkAccess - Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// CompletionPercent - Percentage complete for the background copy when a resource is created via the CopyStart operation.
CompletionPercent *float64 `json:"completionPercent,omitempty"`
// DataAccessAuthMode - Possible values include: 'DataAccessAuthModeAzureActiveDirectory', 'DataAccessAuthModeNone'
DataAccessAuthMode DataAccessAuthMode `json:"dataAccessAuthMode,omitempty"`
}
func (sp SnapshotProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SnapshotProperties.
SnapshotSku the snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
type SnapshotSku struct {
// Name - The sku name. Possible values include: 'SnapshotStorageAccountTypesStandardLRS', 'SnapshotStorageAccountTypesPremiumLRS', 'SnapshotStorageAccountTypesStandardZRS'
Name SnapshotStorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}
func (ss SnapshotSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SnapshotSku.
SnapshotStorageAccountTypes enumerates the values for snapshot storage account types.
type SnapshotStorageAccountTypes string
const (
// SnapshotStorageAccountTypesPremiumLRS Premium SSD locally redundant storage
SnapshotStorageAccountTypesPremiumLRS SnapshotStorageAccountTypes = "Premium_LRS"
// SnapshotStorageAccountTypesStandardLRS Standard HDD locally redundant storage
SnapshotStorageAccountTypesStandardLRS SnapshotStorageAccountTypes = "Standard_LRS"
// SnapshotStorageAccountTypesStandardZRS Standard zone redundant storage
SnapshotStorageAccountTypesStandardZRS SnapshotStorageAccountTypes = "Standard_ZRS"
)
func PossibleSnapshotStorageAccountTypesValues() []SnapshotStorageAccountTypes
PossibleSnapshotStorageAccountTypesValues returns an array of possible values for the SnapshotStorageAccountTypes const type.
SnapshotUpdate snapshot update resource.
type SnapshotUpdate struct {
*SnapshotUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *SnapshotSku `json:"sku,omitempty"`
}
func (su SnapshotUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SnapshotUpdate.
func (su *SnapshotUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SnapshotUpdate struct.
SnapshotUpdateProperties snapshot resource update properties.
type SnapshotUpdateProperties struct {
// OsType - the Operating System type. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
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"`
// Encryption - Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
Encryption *Encryption `json:"encryption,omitempty"`
// NetworkAccessPolicy - Possible values include: 'NetworkAccessPolicyAllowAll', 'NetworkAccessPolicyAllowPrivate', 'NetworkAccessPolicyDenyAll'
NetworkAccessPolicy NetworkAccessPolicy `json:"networkAccessPolicy,omitempty"`
// DiskAccessID - ARM id of the DiskAccess resource for using private endpoints on disks.
DiskAccessID *string `json:"diskAccessId,omitempty"`
// SupportsHibernation - Indicates the OS on a snapshot supports hibernation.
SupportsHibernation *bool `json:"supportsHibernation,omitempty"`
// PublicNetworkAccess - Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
// DataAccessAuthMode - Possible values include: 'DataAccessAuthModeAzureActiveDirectory', 'DataAccessAuthModeNone'
DataAccessAuthMode DataAccessAuthMode `json:"dataAccessAuthMode,omitempty"`
// SupportedCapabilities - List of supported capabilities for the image from which the OS disk was created.
SupportedCapabilities *SupportedCapabilities `json:"supportedCapabilities,omitempty"`
}
SnapshotsClient is the compute Client
type SnapshotsClient struct {
BaseClient
}
func NewSnapshotsClient(subscriptionID string) SnapshotsClient
NewSnapshotsClient creates an instance of the SnapshotsClient client.
func NewSnapshotsClientWithBaseURI(baseURI string, subscriptionID string) SnapshotsClient
NewSnapshotsClientWithBaseURI creates an instance of the SnapshotsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client SnapshotsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, snapshotName string, snapshot Snapshot) (result SnapshotsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. snapshot - snapshot object supplied in the body of the Put disk operation.
func (client SnapshotsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, snapshotName string, snapshot Snapshot) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SnapshotsClient) CreateOrUpdateResponder(resp *http.Response) (result Snapshot, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SnapshotsClient) CreateOrUpdateSender(req *http.Request) (future SnapshotsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Delete(ctx context.Context, resourceGroupName string, snapshotName string) (result SnapshotsDeleteFuture, err error)
Delete deletes a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
func (client SnapshotsClient) DeletePreparer(ctx context.Context, resourceGroupName string, snapshotName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SnapshotsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client SnapshotsClient) DeleteSender(req *http.Request) (future SnapshotsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Get(ctx context.Context, resourceGroupName string, snapshotName string) (result Snapshot, err error)
Get gets information about a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
func (client SnapshotsClient) GetPreparer(ctx context.Context, resourceGroupName string, snapshotName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SnapshotsClient) GetResponder(resp *http.Response) (result Snapshot, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SnapshotsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) GrantAccess(ctx context.Context, resourceGroupName string, snapshotName string, grantAccessData GrantAccessData) (result SnapshotsGrantAccessFuture, err error)
GrantAccess grants access to a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. grantAccessData - access data object supplied in the body of the get snapshot access operation.
func (client SnapshotsClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, snapshotName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
func (client SnapshotsClient) GrantAccessResponder(resp *http.Response) (result AccessURI, err error)
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client SnapshotsClient) GrantAccessSender(req *http.Request) (future SnapshotsGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) List(ctx context.Context) (result SnapshotListPage, err error)
List lists snapshots under a subscription.
func (client SnapshotsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result SnapshotListPage, err error)
ListByResourceGroup lists snapshots under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client SnapshotsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result SnapshotListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SnapshotsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client SnapshotsClient) ListByResourceGroupResponder(resp *http.Response) (result SnapshotList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client SnapshotsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) ListComplete(ctx context.Context) (result SnapshotListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SnapshotsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client SnapshotsClient) ListResponder(resp *http.Response) (result SnapshotList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SnapshotsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) RevokeAccess(ctx context.Context, resourceGroupName string, snapshotName string) (result SnapshotsRevokeAccessFuture, err error)
RevokeAccess revokes access to a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
func (client SnapshotsClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, snapshotName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client SnapshotsClient) RevokeAccessResponder(resp *http.Response) (result autorest.Response, err error)
RevokeAccessResponder handles the response to the RevokeAccess request. The method always closes the http.Response Body.
func (client SnapshotsClient) RevokeAccessSender(req *http.Request) (future SnapshotsRevokeAccessFuture, err error)
RevokeAccessSender sends the RevokeAccess request. The method will close the http.Response Body if it receives an error.
func (client SnapshotsClient) Update(ctx context.Context, resourceGroupName string, snapshotName string, snapshot SnapshotUpdate) (result SnapshotsUpdateFuture, err error)
Update updates (patches) a snapshot. Parameters: resourceGroupName - the name of the resource group. snapshotName - the name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters. snapshot - snapshot object supplied in the body of the Patch snapshot operation.
func (client SnapshotsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, snapshotName string, snapshot SnapshotUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SnapshotsClient) UpdateResponder(resp *http.Response) (result Snapshot, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SnapshotsClient) UpdateSender(req *http.Request) (future SnapshotsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SnapshotsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (Snapshot, error)
}
func (future *SnapshotsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (autorest.Response, error)
}
func (future *SnapshotsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (AccessURI, error)
}
func (future *SnapshotsGrantAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (autorest.Response, error)
}
func (future *SnapshotsRevokeAccessFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SnapshotsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SnapshotsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SnapshotsClient) (Snapshot, error)
}
func (future *SnapshotsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SoftDeletePolicy contains information about the soft deletion policy of the gallery.
type SoftDeletePolicy struct {
// IsSoftDeleteEnabled - Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
IsSoftDeleteEnabled *bool `json:"isSoftDeleteEnabled,omitempty"`
}
SourceVault the vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
type SourceVault struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
SpotRestorePolicy specifies the Spot-Try-Restore properties for the virtual machine scale set. <br><br> With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.
type SpotRestorePolicy struct {
// Enabled - Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints
Enabled *bool `json:"enabled,omitempty"`
// RestoreTimeout - Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances
RestoreTimeout *string `json:"restoreTimeout,omitempty"`
}
StatusCodeCount ...
type StatusCodeCount struct {
// Code - READ-ONLY; The instance view status code
Code *string `json:"code,omitempty"`
// Count - READ-ONLY; Number of instances having this status code
Count *int32 `json:"count,omitempty"`
}
func (scc StatusCodeCount) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for StatusCodeCount.
StatusLevelTypes enumerates the values for status level types.
type StatusLevelTypes string
const (
// StatusLevelTypesError ...
StatusLevelTypesError StatusLevelTypes = "Error"
// StatusLevelTypesInfo ...
StatusLevelTypesInfo StatusLevelTypes = "Info"
// StatusLevelTypesWarning ...
StatusLevelTypesWarning StatusLevelTypes = "Warning"
)
func PossibleStatusLevelTypesValues() []StatusLevelTypes
PossibleStatusLevelTypesValues returns an array of possible values for the StatusLevelTypes const type.
StorageAccountType enumerates the values for storage account type.
type StorageAccountType string
const (
// StorageAccountTypePremiumLRS ...
StorageAccountTypePremiumLRS StorageAccountType = "Premium_LRS"
// StorageAccountTypeStandardLRS ...
StorageAccountTypeStandardLRS StorageAccountType = "Standard_LRS"
// StorageAccountTypeStandardZRS ...
StorageAccountTypeStandardZRS StorageAccountType = "Standard_ZRS"
)
func PossibleStorageAccountTypeValues() []StorageAccountType
PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type.
StorageAccountTypes enumerates the values for storage account types.
type StorageAccountTypes string
const (
// StorageAccountTypesPremiumLRS ...
StorageAccountTypesPremiumLRS StorageAccountTypes = "Premium_LRS"
// StorageAccountTypesPremiumZRS ...
StorageAccountTypesPremiumZRS StorageAccountTypes = "Premium_ZRS"
// StorageAccountTypesStandardLRS ...
StorageAccountTypesStandardLRS StorageAccountTypes = "Standard_LRS"
// StorageAccountTypesStandardSSDLRS ...
StorageAccountTypesStandardSSDLRS StorageAccountTypes = "StandardSSD_LRS"
// StorageAccountTypesStandardSSDZRS ...
StorageAccountTypesStandardSSDZRS StorageAccountTypes = "StandardSSD_ZRS"
// StorageAccountTypesUltraSSDLRS ...
StorageAccountTypesUltraSSDLRS StorageAccountTypes = "UltraSSD_LRS"
)
func PossibleStorageAccountTypesValues() []StorageAccountTypes
PossibleStorageAccountTypesValues returns an array of possible values for the StorageAccountTypes const type.
StorageProfile specifies the storage settings for the virtual machine disks.
type StorageProfile struct {
// ImageReference - Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
ImageReference *ImageReference `json:"imageReference,omitempty"`
// OsDisk - Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
OsDisk *OSDisk `json:"osDisk,omitempty"`
// DataDisks - Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
DataDisks *[]DataDisk `json:"dataDisks,omitempty"`
}
SubResource ...
type SubResource struct {
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
SubResourceReadOnly ...
type SubResourceReadOnly struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (srro SubResourceReadOnly) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubResourceReadOnly.
SubResourceWithColocationStatus ...
type SubResourceWithColocationStatus struct {
// ColocationStatus - Describes colocation status of a resource in the Proximity Placement Group.
ColocationStatus *InstanceViewStatus `json:"colocationStatus,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
SupportedCapabilities list of supported capabilities persisted on the disk resource for VM use.
type SupportedCapabilities struct {
// AcceleratedNetwork - True if the image from which the OS disk is created supports accelerated networking.
AcceleratedNetwork *bool `json:"acceleratedNetwork,omitempty"`
// Architecture - CPU architecture supported by an OS disk. Possible values include: 'ArchitectureX64', 'ArchitectureArm64'
Architecture Architecture `json:"architecture,omitempty"`
}
TargetRegion describes the target region information.
type TargetRegion struct {
// Name - The name of the region.
Name *string `json:"name,omitempty"`
// RegionalReplicaCount - The number of replicas of the Image Version to be created per region. This property is updatable.
RegionalReplicaCount *int32 `json:"regionalReplicaCount,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"`
Encryption *EncryptionImages `json:"encryption,omitempty"`
}
TerminateNotificationProfile ...
type TerminateNotificationProfile struct {
// NotBeforeTimeout - Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)
NotBeforeTimeout *string `json:"notBeforeTimeout,omitempty"`
// Enable - Specifies whether the Terminate Scheduled event is enabled or disabled.
Enable *bool `json:"enable,omitempty"`
}
ThrottledRequestsInput api request input for LogAnalytics getThrottledRequests Api.
type ThrottledRequestsInput struct {
// BlobContainerSasURI - SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
BlobContainerSasURI *string `json:"blobContainerSasUri,omitempty"`
// FromTime - From time of the query
FromTime *date.Time `json:"fromTime,omitempty"`
// ToTime - To time of the query
ToTime *date.Time `json:"toTime,omitempty"`
// GroupByThrottlePolicy - Group query result by Throttle Policy applied.
GroupByThrottlePolicy *bool `json:"groupByThrottlePolicy,omitempty"`
// GroupByOperationName - Group query result by Operation Name.
GroupByOperationName *bool `json:"groupByOperationName,omitempty"`
// GroupByResourceName - Group query result by Resource Name.
GroupByResourceName *bool `json:"groupByResourceName,omitempty"`
// GroupByClientApplicationID - Group query result by Client Application ID.
GroupByClientApplicationID *bool `json:"groupByClientApplicationId,omitempty"`
// GroupByUserAgent - Group query result by User Agent.
GroupByUserAgent *bool `json:"groupByUserAgent,omitempty"`
}
UefiSettings specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01
type UefiSettings struct {
// SecureBootEnabled - Specifies whether secure boot should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01
SecureBootEnabled *bool `json:"secureBootEnabled,omitempty"`
// VTpmEnabled - Specifies whether vTPM should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01
VTpmEnabled *bool `json:"vTpmEnabled,omitempty"`
}
UpdateDomain defines an update domain for the cloud service.
type UpdateDomain struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource Name
Name *string `json:"name,omitempty"`
}
func (ud UpdateDomain) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateDomain.
UpdateDomainListResult ...
type UpdateDomainListResult struct {
autorest.Response `json:"-"`
Value *[]UpdateDomain `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (udlr UpdateDomainListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
UpdateDomainListResultIterator provides access to a complete listing of UpdateDomain values.
type UpdateDomainListResultIterator struct {
// contains filtered or unexported fields
}
func NewUpdateDomainListResultIterator(page UpdateDomainListResultPage) UpdateDomainListResultIterator
Creates a new instance of the UpdateDomainListResultIterator type.
func (iter *UpdateDomainListResultIterator) 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 *UpdateDomainListResultIterator) 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 UpdateDomainListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter UpdateDomainListResultIterator) Response() UpdateDomainListResult
Response returns the raw server response from the last page request.
func (iter UpdateDomainListResultIterator) Value() UpdateDomain
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
UpdateDomainListResultPage contains a page of UpdateDomain values.
type UpdateDomainListResultPage struct {
// contains filtered or unexported fields
}
func NewUpdateDomainListResultPage(cur UpdateDomainListResult, getNextPage func(context.Context, UpdateDomainListResult) (UpdateDomainListResult, error)) UpdateDomainListResultPage
Creates a new instance of the UpdateDomainListResultPage type.
func (page *UpdateDomainListResultPage) 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 *UpdateDomainListResultPage) 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 UpdateDomainListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page UpdateDomainListResultPage) Response() UpdateDomainListResult
Response returns the raw server response from the last page request.
func (page UpdateDomainListResultPage) Values() []UpdateDomain
Values returns the slice of values for the current page or nil if there are no values.
UpdateResource the Update Resource model definition.
type UpdateResource struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (ur UpdateResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateResource.
UpdateResourceDefinition the Update Resource model definition.
type UpdateResourceDefinition struct {
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (urd UpdateResourceDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateResourceDefinition.
UpgradeMode enumerates the values for upgrade mode.
type UpgradeMode string
const (
// UpgradeModeAutomatic ...
UpgradeModeAutomatic UpgradeMode = "Automatic"
// UpgradeModeManual ...
UpgradeModeManual UpgradeMode = "Manual"
// UpgradeModeRolling ...
UpgradeModeRolling UpgradeMode = "Rolling"
)
func PossibleUpgradeModeValues() []UpgradeMode
PossibleUpgradeModeValues returns an array of possible values for the UpgradeMode const type.
UpgradeOperationHistoricalStatusInfo virtual Machine Scale Set OS Upgrade History operation response.
type UpgradeOperationHistoricalStatusInfo struct {
// Properties - READ-ONLY; Information about the properties of the upgrade operation.
Properties *UpgradeOperationHistoricalStatusInfoProperties `json:"properties,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - READ-ONLY; Resource location
Location *string `json:"location,omitempty"`
}
func (uohsi UpgradeOperationHistoricalStatusInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpgradeOperationHistoricalStatusInfo.
UpgradeOperationHistoricalStatusInfoProperties describes each OS upgrade on the Virtual Machine Scale Set.
type UpgradeOperationHistoricalStatusInfoProperties struct {
// RunningStatus - READ-ONLY; Information about the overall status of the upgrade operation.
RunningStatus *UpgradeOperationHistoryStatus `json:"runningStatus,omitempty"`
// Progress - READ-ONLY; Counts of the VMs in each state.
Progress *RollingUpgradeProgressInfo `json:"progress,omitempty"`
// Error - READ-ONLY; Error Details for this upgrade if there are any.
Error *APIError `json:"error,omitempty"`
// StartedBy - READ-ONLY; Invoker of the Upgrade Operation. Possible values include: 'UpgradeOperationInvokerUnknown', 'UpgradeOperationInvokerUser', 'UpgradeOperationInvokerPlatform'
StartedBy UpgradeOperationInvoker `json:"startedBy,omitempty"`
// TargetImageReference - READ-ONLY; Image Reference details
TargetImageReference *ImageReference `json:"targetImageReference,omitempty"`
// RollbackInfo - READ-ONLY; Information about OS rollback if performed
RollbackInfo *RollbackStatusInfo `json:"rollbackInfo,omitempty"`
}
func (uohsip UpgradeOperationHistoricalStatusInfoProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpgradeOperationHistoricalStatusInfoProperties.
UpgradeOperationHistoryStatus information about the current running state of the overall upgrade.
type UpgradeOperationHistoryStatus struct {
// Code - READ-ONLY; Code indicating the current status of the upgrade. Possible values include: 'UpgradeStateRollingForward', 'UpgradeStateCancelled', 'UpgradeStateCompleted', 'UpgradeStateFaulted'
Code UpgradeState `json:"code,omitempty"`
// StartTime - READ-ONLY; Start time of the upgrade.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; End time of the upgrade.
EndTime *date.Time `json:"endTime,omitempty"`
}
func (uohs UpgradeOperationHistoryStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpgradeOperationHistoryStatus.
UpgradeOperationInvoker enumerates the values for upgrade operation invoker.
type UpgradeOperationInvoker string
const (
// UpgradeOperationInvokerPlatform ...
UpgradeOperationInvokerPlatform UpgradeOperationInvoker = "Platform"
// UpgradeOperationInvokerUnknown ...
UpgradeOperationInvokerUnknown UpgradeOperationInvoker = "Unknown"
// UpgradeOperationInvokerUser ...
UpgradeOperationInvokerUser UpgradeOperationInvoker = "User"
)
func PossibleUpgradeOperationInvokerValues() []UpgradeOperationInvoker
PossibleUpgradeOperationInvokerValues returns an array of possible values for the UpgradeOperationInvoker const type.
UpgradePolicy describes an upgrade policy - automatic, manual, or rolling.
type UpgradePolicy struct {
// Mode - Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time. Possible values include: 'UpgradeModeAutomatic', 'UpgradeModeManual', 'UpgradeModeRolling'
Mode UpgradeMode `json:"mode,omitempty"`
// RollingUpgradePolicy - The configuration parameters used while performing a rolling upgrade.
RollingUpgradePolicy *RollingUpgradePolicy `json:"rollingUpgradePolicy,omitempty"`
// AutomaticOSUpgradePolicy - Configuration parameters used for performing automatic OS Upgrade.
AutomaticOSUpgradePolicy *AutomaticOSUpgradePolicy `json:"automaticOSUpgradePolicy,omitempty"`
}
UpgradeState enumerates the values for upgrade state.
type UpgradeState string
const (
// UpgradeStateCancelled ...
UpgradeStateCancelled UpgradeState = "Cancelled"
// UpgradeStateCompleted ...
UpgradeStateCompleted UpgradeState = "Completed"
// UpgradeStateFaulted ...
UpgradeStateFaulted UpgradeState = "Faulted"
// UpgradeStateRollingForward ...
UpgradeStateRollingForward UpgradeState = "RollingForward"
)
func PossibleUpgradeStateValues() []UpgradeState
PossibleUpgradeStateValues returns an array of possible values for the UpgradeState const type.
Usage describes Compute Resource Usage.
type Usage struct {
// Unit - An enum describing the unit of usage measurement.
Unit *string `json:"unit,omitempty"`
// CurrentValue - The current usage of the resource.
CurrentValue *int32 `json:"currentValue,omitempty"`
// Limit - The maximum permitted usage of the resource.
Limit *int64 `json:"limit,omitempty"`
// Name - The name of the type of usage.
Name *UsageName `json:"name,omitempty"`
}
UsageClient is the compute Client
type UsageClient struct {
BaseClient
}
func NewUsageClient(subscriptionID string) UsageClient
NewUsageClient creates an instance of the UsageClient client.
func NewUsageClientWithBaseURI(baseURI string, subscriptionID string) UsageClient
NewUsageClientWithBaseURI creates an instance of the UsageClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client UsageClient) List(ctx context.Context, location string) (result ListUsagesResultPage, err error)
List gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription. Parameters: location - the location for which resource usage is queried.
func (client UsageClient) ListComplete(ctx context.Context, location string) (result ListUsagesResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UsageClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client UsageClient) ListResponder(resp *http.Response) (result ListUsagesResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client UsageClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
UsageName the Usage Names.
type UsageName struct {
// Value - The name of the resource.
Value *string `json:"value,omitempty"`
// LocalizedValue - The localized name of the resource.
LocalizedValue *string `json:"localizedValue,omitempty"`
}
UserArtifactManage ...
type UserArtifactManage struct {
// Install - Required. The path and arguments to install the gallery application. This is limited to 4096 characters.
Install *string `json:"install,omitempty"`
// Remove - Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.
Remove *string `json:"remove,omitempty"`
// Update - Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.
Update *string `json:"update,omitempty"`
}
UserArtifactSource the source image from which the Image Version is going to be created.
type UserArtifactSource struct {
// MediaLink - Required. The mediaLink of the artifact, must be a readable storage page blob.
MediaLink *string `json:"mediaLink,omitempty"`
// DefaultConfigurationLink - Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob.
DefaultConfigurationLink *string `json:"defaultConfigurationLink,omitempty"`
}
VMDiskSecurityProfile specifies the security profile settings for the managed disk. <br><br> NOTE: It can only be set for Confidential VMs
type VMDiskSecurityProfile struct {
// SecurityEncryptionType - Specifies the EncryptionType of the managed disk. <br> It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. <br><br> NOTE: It can be set for only Confidential VMs. Possible values include: 'SecurityEncryptionTypesVMGuestStateOnly', 'SecurityEncryptionTypesDiskWithVMGuestState'
SecurityEncryptionType SecurityEncryptionTypes `json:"securityEncryptionType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
}
VMDiskTypes enumerates the values for vm disk types.
type VMDiskTypes string
const (
// VMDiskTypesNone ...
VMDiskTypesNone VMDiskTypes = "None"
// VMDiskTypesUnmanaged ...
VMDiskTypesUnmanaged VMDiskTypes = "Unmanaged"
)
func PossibleVMDiskTypesValues() []VMDiskTypes
PossibleVMDiskTypesValues returns an array of possible values for the VMDiskTypes const type.
VMGalleryApplication specifies the required information to reference a compute gallery application version
type VMGalleryApplication struct {
// Tags - Optional, Specifies a passthrough value for more generic context.
Tags *string `json:"tags,omitempty"`
// Order - Optional, Specifies the order in which the packages have to be installed
Order *int32 `json:"order,omitempty"`
// PackageReferenceID - Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}
PackageReferenceID *string `json:"packageReferenceId,omitempty"`
// ConfigurationReference - Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided
ConfigurationReference *string `json:"configurationReference,omitempty"`
}
VMGuestPatchClassificationLinux enumerates the values for vm guest patch classification linux.
type VMGuestPatchClassificationLinux string
const (
// VMGuestPatchClassificationLinuxCritical ...
VMGuestPatchClassificationLinuxCritical VMGuestPatchClassificationLinux = "Critical"
// VMGuestPatchClassificationLinuxOther ...
VMGuestPatchClassificationLinuxOther VMGuestPatchClassificationLinux = "Other"
// VMGuestPatchClassificationLinuxSecurity ...
VMGuestPatchClassificationLinuxSecurity VMGuestPatchClassificationLinux = "Security"
)
func PossibleVMGuestPatchClassificationLinuxValues() []VMGuestPatchClassificationLinux
PossibleVMGuestPatchClassificationLinuxValues returns an array of possible values for the VMGuestPatchClassificationLinux const type.
VMGuestPatchClassificationWindows enumerates the values for vm guest patch classification windows.
type VMGuestPatchClassificationWindows string
const (
// VMGuestPatchClassificationWindowsCritical ...
VMGuestPatchClassificationWindowsCritical VMGuestPatchClassificationWindows = "Critical"
// VMGuestPatchClassificationWindowsDefinition ...
VMGuestPatchClassificationWindowsDefinition VMGuestPatchClassificationWindows = "Definition"
// VMGuestPatchClassificationWindowsFeaturePack ...
VMGuestPatchClassificationWindowsFeaturePack VMGuestPatchClassificationWindows = "FeaturePack"
// VMGuestPatchClassificationWindowsSecurity ...
VMGuestPatchClassificationWindowsSecurity VMGuestPatchClassificationWindows = "Security"
// VMGuestPatchClassificationWindowsServicePack ...
VMGuestPatchClassificationWindowsServicePack VMGuestPatchClassificationWindows = "ServicePack"
// VMGuestPatchClassificationWindowsTools ...
VMGuestPatchClassificationWindowsTools VMGuestPatchClassificationWindows = "Tools"
// VMGuestPatchClassificationWindowsUpdateRollUp ...
VMGuestPatchClassificationWindowsUpdateRollUp VMGuestPatchClassificationWindows = "UpdateRollUp"
// VMGuestPatchClassificationWindowsUpdates ...
VMGuestPatchClassificationWindowsUpdates VMGuestPatchClassificationWindows = "Updates"
)
func PossibleVMGuestPatchClassificationWindowsValues() []VMGuestPatchClassificationWindows
PossibleVMGuestPatchClassificationWindowsValues returns an array of possible values for the VMGuestPatchClassificationWindows const type.
VMGuestPatchRebootBehavior enumerates the values for vm guest patch reboot behavior.
type VMGuestPatchRebootBehavior string
const (
// VMGuestPatchRebootBehaviorAlwaysRequiresReboot ...
VMGuestPatchRebootBehaviorAlwaysRequiresReboot VMGuestPatchRebootBehavior = "AlwaysRequiresReboot"
// VMGuestPatchRebootBehaviorCanRequestReboot ...
VMGuestPatchRebootBehaviorCanRequestReboot VMGuestPatchRebootBehavior = "CanRequestReboot"
// VMGuestPatchRebootBehaviorNeverReboots ...
VMGuestPatchRebootBehaviorNeverReboots VMGuestPatchRebootBehavior = "NeverReboots"
// VMGuestPatchRebootBehaviorUnknown ...
VMGuestPatchRebootBehaviorUnknown VMGuestPatchRebootBehavior = "Unknown"
)
func PossibleVMGuestPatchRebootBehaviorValues() []VMGuestPatchRebootBehavior
PossibleVMGuestPatchRebootBehaviorValues returns an array of possible values for the VMGuestPatchRebootBehavior const type.
VMGuestPatchRebootSetting enumerates the values for vm guest patch reboot setting.
type VMGuestPatchRebootSetting string
const (
// VMGuestPatchRebootSettingAlways ...
VMGuestPatchRebootSettingAlways VMGuestPatchRebootSetting = "Always"
// VMGuestPatchRebootSettingIfRequired ...
VMGuestPatchRebootSettingIfRequired VMGuestPatchRebootSetting = "IfRequired"
// VMGuestPatchRebootSettingNever ...
VMGuestPatchRebootSettingNever VMGuestPatchRebootSetting = "Never"
)
func PossibleVMGuestPatchRebootSettingValues() []VMGuestPatchRebootSetting
PossibleVMGuestPatchRebootSettingValues returns an array of possible values for the VMGuestPatchRebootSetting const type.
VMGuestPatchRebootStatus enumerates the values for vm guest patch reboot status.
type VMGuestPatchRebootStatus string
const (
// VMGuestPatchRebootStatusCompleted ...
VMGuestPatchRebootStatusCompleted VMGuestPatchRebootStatus = "Completed"
// VMGuestPatchRebootStatusFailed ...
VMGuestPatchRebootStatusFailed VMGuestPatchRebootStatus = "Failed"
// VMGuestPatchRebootStatusNotNeeded ...
VMGuestPatchRebootStatusNotNeeded VMGuestPatchRebootStatus = "NotNeeded"
// VMGuestPatchRebootStatusRequired ...
VMGuestPatchRebootStatusRequired VMGuestPatchRebootStatus = "Required"
// VMGuestPatchRebootStatusStarted ...
VMGuestPatchRebootStatusStarted VMGuestPatchRebootStatus = "Started"
// VMGuestPatchRebootStatusUnknown ...
VMGuestPatchRebootStatusUnknown VMGuestPatchRebootStatus = "Unknown"
)
func PossibleVMGuestPatchRebootStatusValues() []VMGuestPatchRebootStatus
PossibleVMGuestPatchRebootStatusValues returns an array of possible values for the VMGuestPatchRebootStatus const type.
VMScaleSetConvertToSinglePlacementGroupInput ...
type VMScaleSetConvertToSinglePlacementGroupInput struct {
// ActivePlacementGroupID - Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances.
ActivePlacementGroupID *string `json:"activePlacementGroupId,omitempty"`
}
VMSizeProperties specifies VM Size Property settings on the virtual machine.
type VMSizeProperties struct {
// VCPUsAvailable - Specifies the number of vCPUs available for the VM. <br><br> When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) .
VCPUsAvailable *int32 `json:"vCPUsAvailable,omitempty"`
// VCPUsPerCore - Specifies the vCPU to physical core ratio. <br><br> When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) <br><br> Setting this property to 1 also means that hyper-threading is disabled.
VCPUsPerCore *int32 `json:"vCPUsPerCore,omitempty"`
}
VaultCertificate describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
type VaultCertificate struct {
// CertificateURL - This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
CertificateURL *string `json:"certificateUrl,omitempty"`
// CertificateStore - For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
CertificateStore *string `json:"certificateStore,omitempty"`
}
VaultSecretGroup describes a set of certificates which are all in the same Key Vault.
type VaultSecretGroup struct {
// SourceVault - The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
SourceVault *SubResource `json:"sourceVault,omitempty"`
// VaultCertificates - The list of key vault references in SourceVault which contain certificates.
VaultCertificates *[]VaultCertificate `json:"vaultCertificates,omitempty"`
}
VirtualHardDisk describes the uri of a disk.
type VirtualHardDisk struct {
// URI - Specifies the virtual hard disk's uri.
URI *string `json:"uri,omitempty"`
}
VirtualMachine describes a Virtual Machine.
type VirtualMachine struct {
autorest.Response `json:"-"`
// Plan - Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineProperties `json:"properties,omitempty"`
// Resources - READ-ONLY; The virtual machine child extension resources.
Resources *[]VirtualMachineExtension `json:"resources,omitempty"`
// Identity - The identity of the virtual machine, if configured.
Identity *VirtualMachineIdentity `json:"identity,omitempty"`
// Zones - The virtual machine zones.
Zones *[]string `json:"zones,omitempty"`
// ExtendedLocation - The extended location of the Virtual Machine.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (VM VirtualMachine) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachine.
func (VM *VirtualMachine) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachine struct.
VirtualMachineAgentInstanceView the instance view of the VM Agent running on the virtual machine.
type VirtualMachineAgentInstanceView struct {
// VMAgentVersion - The VM Agent full version.
VMAgentVersion *string `json:"vmAgentVersion,omitempty"`
// ExtensionHandlers - The virtual machine extension handler instance view.
ExtensionHandlers *[]VirtualMachineExtensionHandlerInstanceView `json:"extensionHandlers,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
VirtualMachineAssessPatchesResult describes the properties of an AssessPatches result.
type VirtualMachineAssessPatchesResult struct {
autorest.Response `json:"-"`
// Status - READ-ONLY; The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings.". Possible values include: 'PatchOperationStatusUnknown', 'PatchOperationStatusInProgress', 'PatchOperationStatusFailed', 'PatchOperationStatusSucceeded', 'PatchOperationStatusCompletedWithWarnings'
Status PatchOperationStatus `json:"status,omitempty"`
// AssessmentActivityID - READ-ONLY; The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
AssessmentActivityID *string `json:"assessmentActivityId,omitempty"`
// RebootPending - READ-ONLY; The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.
RebootPending *bool `json:"rebootPending,omitempty"`
// CriticalAndSecurityPatchCount - READ-ONLY; The number of critical or security patches that have been detected as available and not yet installed.
CriticalAndSecurityPatchCount *int32 `json:"criticalAndSecurityPatchCount,omitempty"`
// OtherPatchCount - READ-ONLY; The number of all available patches excluding critical and security.
OtherPatchCount *int32 `json:"otherPatchCount,omitempty"`
// StartDateTime - READ-ONLY; The UTC timestamp when the operation began.
StartDateTime *date.Time `json:"startDateTime,omitempty"`
// AvailablePatches - READ-ONLY; The list of patches that have been detected as available for installation.
AvailablePatches *[]VirtualMachineSoftwarePatchProperties `json:"availablePatches,omitempty"`
// Error - READ-ONLY; The errors that were encountered during execution of the operation. The details array contains the list of them.
Error *APIError `json:"error,omitempty"`
}
func (vmapr VirtualMachineAssessPatchesResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineAssessPatchesResult.
VirtualMachineCaptureParameters capture Virtual Machine parameters.
type VirtualMachineCaptureParameters struct {
// VhdPrefix - The captured virtual hard disk's name prefix.
VhdPrefix *string `json:"vhdPrefix,omitempty"`
// DestinationContainerName - The destination container name.
DestinationContainerName *string `json:"destinationContainerName,omitempty"`
// OverwriteVhds - Specifies whether to overwrite the destination virtual hard disk, in case of conflict.
OverwriteVhds *bool `json:"overwriteVhds,omitempty"`
}
VirtualMachineCaptureResult output of virtual machine capture operation.
type VirtualMachineCaptureResult struct {
autorest.Response `json:"-"`
// Schema - READ-ONLY; the schema of the captured virtual machine
Schema *string `json:"$schema,omitempty"`
// ContentVersion - READ-ONLY; the version of the content
ContentVersion *string `json:"contentVersion,omitempty"`
// Parameters - READ-ONLY; parameters of the captured virtual machine
Parameters interface{} `json:"parameters,omitempty"`
// Resources - READ-ONLY; a list of resource items of the captured virtual machine
Resources *[]interface{} `json:"resources,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmcr VirtualMachineCaptureResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineCaptureResult.
VirtualMachineEvictionPolicyTypes enumerates the values for virtual machine eviction policy types.
type VirtualMachineEvictionPolicyTypes string
const (
// VirtualMachineEvictionPolicyTypesDeallocate ...
VirtualMachineEvictionPolicyTypesDeallocate VirtualMachineEvictionPolicyTypes = "Deallocate"
// VirtualMachineEvictionPolicyTypesDelete ...
VirtualMachineEvictionPolicyTypesDelete VirtualMachineEvictionPolicyTypes = "Delete"
)
func PossibleVirtualMachineEvictionPolicyTypesValues() []VirtualMachineEvictionPolicyTypes
PossibleVirtualMachineEvictionPolicyTypesValues returns an array of possible values for the VirtualMachineEvictionPolicyTypes const type.
VirtualMachineExtension describes a Virtual Machine Extension.
type VirtualMachineExtension struct {
autorest.Response `json:"-"`
*VirtualMachineExtensionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vme VirtualMachineExtension) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtension.
func (vme *VirtualMachineExtension) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtension struct.
VirtualMachineExtensionHandlerInstanceView the instance view of a virtual machine extension handler.
type VirtualMachineExtensionHandlerInstanceView struct {
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// Status - The extension handler status.
Status *InstanceViewStatus `json:"status,omitempty"`
}
VirtualMachineExtensionImage describes a Virtual Machine Extension Image.
type VirtualMachineExtensionImage struct {
autorest.Response `json:"-"`
*VirtualMachineExtensionImageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmei VirtualMachineExtensionImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionImage.
func (vmei *VirtualMachineExtensionImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtensionImage struct.
VirtualMachineExtensionImageProperties describes the properties of a Virtual Machine Extension Image.
type VirtualMachineExtensionImageProperties struct {
// OperatingSystem - The operating system this extension supports.
OperatingSystem *string `json:"operatingSystem,omitempty"`
// ComputeRole - The type of role (IaaS or PaaS) this extension supports.
ComputeRole *string `json:"computeRole,omitempty"`
// HandlerSchema - The schema defined by publisher, where extension consumers should provide settings in a matching schema.
HandlerSchema *string `json:"handlerSchema,omitempty"`
// VMScaleSetEnabled - Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
VMScaleSetEnabled *bool `json:"vmScaleSetEnabled,omitempty"`
// SupportsMultipleExtensions - Whether the handler can support multiple extensions.
SupportsMultipleExtensions *bool `json:"supportsMultipleExtensions,omitempty"`
}
VirtualMachineExtensionImagesClient is the compute Client
type VirtualMachineExtensionImagesClient struct {
BaseClient
}
func NewVirtualMachineExtensionImagesClient(subscriptionID string) VirtualMachineExtensionImagesClient
NewVirtualMachineExtensionImagesClient creates an instance of the VirtualMachineExtensionImagesClient client.
func NewVirtualMachineExtensionImagesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineExtensionImagesClient
NewVirtualMachineExtensionImagesClientWithBaseURI creates an instance of the VirtualMachineExtensionImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineExtensionImagesClient) Get(ctx context.Context, location string, publisherName string, typeParameter string, version string) (result VirtualMachineExtensionImage, err error)
Get gets a virtual machine extension image. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineExtensionImagesClient) GetPreparer(ctx context.Context, location string, publisherName string, typeParameter string, version string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineExtensionImagesClient) GetResponder(resp *http.Response) (result VirtualMachineExtensionImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionImagesClient) ListTypes(ctx context.Context, location string, publisherName string) (result ListVirtualMachineExtensionImage, err error)
ListTypes gets a list of virtual machine extension image types. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineExtensionImagesClient) ListTypesPreparer(ctx context.Context, location string, publisherName string) (*http.Request, error)
ListTypesPreparer prepares the ListTypes request.
func (client VirtualMachineExtensionImagesClient) ListTypesResponder(resp *http.Response) (result ListVirtualMachineExtensionImage, err error)
ListTypesResponder handles the response to the ListTypes request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) ListTypesSender(req *http.Request) (*http.Response, error)
ListTypesSender sends the ListTypes request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionImagesClient) ListVersions(ctx context.Context, location string, publisherName string, typeParameter string, filter string, top *int32, orderby string) (result ListVirtualMachineExtensionImage, err error)
ListVersions gets a list of virtual machine extension image versions. Parameters: location - the name of a supported Azure region. filter - the filter to apply on the operation.
func (client VirtualMachineExtensionImagesClient) ListVersionsPreparer(ctx context.Context, location string, publisherName string, typeParameter string, filter string, top *int32, orderby string) (*http.Request, error)
ListVersionsPreparer prepares the ListVersions request.
func (client VirtualMachineExtensionImagesClient) ListVersionsResponder(resp *http.Response) (result ListVirtualMachineExtensionImage, err error)
ListVersionsResponder handles the response to the ListVersions request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionImagesClient) ListVersionsSender(req *http.Request) (*http.Response, error)
ListVersionsSender sends the ListVersions request. The method will close the http.Response Body if it receives an error.
VirtualMachineExtensionInstanceView the instance view of a virtual machine extension.
type VirtualMachineExtensionInstanceView struct {
// Name - The virtual machine extension name.
Name *string `json:"name,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// Substatuses - The resource status information.
Substatuses *[]InstanceViewStatus `json:"substatuses,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
VirtualMachineExtensionProperties describes the properties of a Virtual Machine Extension.
type VirtualMachineExtensionProperties struct {
// ForceUpdateTag - How the extension handler should be forced to update even if the extension configuration has not changed.
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// EnableAutomaticUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
EnableAutomaticUpgrade *bool `json:"enableAutomaticUpgrade,omitempty"`
// Settings - Json formatted public settings for the extension.
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - The virtual machine extension instance view.
InstanceView *VirtualMachineExtensionInstanceView `json:"instanceView,omitempty"`
// SuppressFailures - Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
SuppressFailures *bool `json:"suppressFailures,omitempty"`
// ProtectedSettingsFromKeyVault - The extensions protected settings that are passed by reference, and consumed from key vault
ProtectedSettingsFromKeyVault interface{} `json:"protectedSettingsFromKeyVault,omitempty"`
}
func (vmep VirtualMachineExtensionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionProperties.
VirtualMachineExtensionUpdate describes a Virtual Machine Extension.
type VirtualMachineExtensionUpdate struct {
*VirtualMachineExtensionUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmeu VirtualMachineExtensionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineExtensionUpdate.
func (vmeu *VirtualMachineExtensionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineExtensionUpdate struct.
VirtualMachineExtensionUpdateProperties describes the properties of a Virtual Machine Extension.
type VirtualMachineExtensionUpdateProperties struct {
// ForceUpdateTag - How the extension handler should be forced to update even if the extension configuration has not changed.
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// EnableAutomaticUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
EnableAutomaticUpgrade *bool `json:"enableAutomaticUpgrade,omitempty"`
// Settings - Json formatted public settings for the extension.
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
// SuppressFailures - Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
SuppressFailures *bool `json:"suppressFailures,omitempty"`
// ProtectedSettingsFromKeyVault - The extensions protected settings that are passed by reference, and consumed from key vault
ProtectedSettingsFromKeyVault interface{} `json:"protectedSettingsFromKeyVault,omitempty"`
}
VirtualMachineExtensionsClient is the compute Client
type VirtualMachineExtensionsClient struct {
BaseClient
}
func NewVirtualMachineExtensionsClient(subscriptionID string) VirtualMachineExtensionsClient
NewVirtualMachineExtensionsClient creates an instance of the VirtualMachineExtensionsClient client.
func NewVirtualMachineExtensionsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineExtensionsClient
NewVirtualMachineExtensionsClientWithBaseURI creates an instance of the VirtualMachineExtensionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineExtensionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtension) (result VirtualMachineExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be created or updated. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Create Virtual Machine Extension operation.
func (client VirtualMachineExtensionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtension) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineExtensionsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineExtension, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) Delete(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string) (result VirtualMachineExtensionsDeleteFuture, err error)
Delete the operation to delete the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be deleted. VMExtensionName - the name of the virtual machine extension.
func (client VirtualMachineExtensionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineExtensionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) DeleteSender(req *http.Request) (future VirtualMachineExtensionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) Get(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, expand string) (result VirtualMachineExtension, err error)
Get the operation to get the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the extension. VMExtensionName - the name of the virtual machine extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineExtensionsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineExtensionsClient) GetResponder(resp *http.Response) (result VirtualMachineExtension, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) List(ctx context.Context, resourceGroupName string, VMName string, expand string) (result VirtualMachineExtensionsListResult, err error)
List the operation to get all extensions of a Virtual Machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineExtensionsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMName string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineExtensionsClient) ListResponder(resp *http.Response) (result VirtualMachineExtensionsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineExtensionsClient) Update(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtensionUpdate) (result VirtualMachineExtensionsUpdateFuture, err error)
Update the operation to update the extension. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the extension should be updated. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Update Virtual Machine Extension operation.
func (client VirtualMachineExtensionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, VMExtensionName string, extensionParameters VirtualMachineExtensionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineExtensionsClient) UpdateResponder(resp *http.Response) (result VirtualMachineExtension, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineExtensionsClient) UpdateSender(req *http.Request) (future VirtualMachineExtensionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineExtensionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineExtensionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (VirtualMachineExtension, error)
}
func (future *VirtualMachineExtensionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineExtensionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (autorest.Response, error)
}
func (future *VirtualMachineExtensionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineExtensionsListResult the List Extension operation response
type VirtualMachineExtensionsListResult struct {
autorest.Response `json:"-"`
// Value - The list of extensions
Value *[]VirtualMachineExtension `json:"value,omitempty"`
}
VirtualMachineExtensionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineExtensionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineExtensionsClient) (VirtualMachineExtension, error)
}
func (future *VirtualMachineExtensionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineHealthStatus the health status of the VM.
type VirtualMachineHealthStatus struct {
// Status - READ-ONLY; The health status information for the VM.
Status *InstanceViewStatus `json:"status,omitempty"`
}
func (vmhs VirtualMachineHealthStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineHealthStatus.
VirtualMachineIPTag contains the IP tag associated with the public IP address.
type VirtualMachineIPTag struct {
// IPTagType - IP tag type. Example: FirstPartyUsage.
IPTagType *string `json:"ipTagType,omitempty"`
// Tag - IP tag associated with the public IP. Example: SQL, Storage etc.
Tag *string `json:"tag,omitempty"`
}
VirtualMachineIdentity identity for the virtual machine.
type VirtualMachineIdentity struct {
// PrincipalID - READ-ONLY; The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
// UserAssignedIdentities - The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
UserAssignedIdentities map[string]*VirtualMachineIdentityUserAssignedIdentitiesValue `json:"userAssignedIdentities"`
}
func (vmi VirtualMachineIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineIdentity.
VirtualMachineIdentityUserAssignedIdentitiesValue ...
type VirtualMachineIdentityUserAssignedIdentitiesValue struct {
// PrincipalID - READ-ONLY; The principal id of user assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// ClientID - READ-ONLY; The client id of user assigned identity.
ClientID *string `json:"clientId,omitempty"`
}
func (vmiAiv VirtualMachineIdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineIdentityUserAssignedIdentitiesValue.
VirtualMachineImage describes a Virtual Machine Image.
type VirtualMachineImage struct {
autorest.Response `json:"-"`
*VirtualMachineImageProperties `json:"properties,omitempty"`
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Location - The supported Azure location of the resource.
Location *string `json:"location,omitempty"`
// Tags - Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
Tags map[string]*string `json:"tags"`
// ExtendedLocation - The extended location of the Virtual Machine.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmi VirtualMachineImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineImage.
func (vmi *VirtualMachineImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineImage struct.
VirtualMachineImageFeature specifies additional capabilities supported by the image
type VirtualMachineImageFeature struct {
// Name - The name of the feature.
Name *string `json:"name,omitempty"`
// Value - The corresponding value for the feature.
Value *string `json:"value,omitempty"`
}
VirtualMachineImageProperties describes the properties of a Virtual Machine Image.
type VirtualMachineImageProperties struct {
Plan *PurchasePlan `json:"plan,omitempty"`
OsDiskImage *OSDiskImage `json:"osDiskImage,omitempty"`
DataDiskImages *[]DataDiskImage `json:"dataDiskImages,omitempty"`
AutomaticOSUpgradeProperties *AutomaticOSUpgradeProperties `json:"automaticOSUpgradeProperties,omitempty"`
// HyperVGeneration - Possible values include: 'HyperVGenerationTypesV1', 'HyperVGenerationTypesV2'
HyperVGeneration HyperVGenerationTypes `json:"hyperVGeneration,omitempty"`
// Disallowed - Specifies disallowed configuration for the VirtualMachine created from the image
Disallowed *DisallowedConfiguration `json:"disallowed,omitempty"`
Features *[]VirtualMachineImageFeature `json:"features,omitempty"`
// Architecture - Possible values include: 'ArchitectureTypesX64', 'ArchitectureTypesArm64'
Architecture ArchitectureTypes `json:"architecture,omitempty"`
}
VirtualMachineImageResource virtual machine image resource information.
type VirtualMachineImageResource struct {
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Location - The supported Azure location of the resource.
Location *string `json:"location,omitempty"`
// Tags - Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
Tags map[string]*string `json:"tags"`
// ExtendedLocation - The extended location of the Virtual Machine.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmir VirtualMachineImageResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineImageResource.
VirtualMachineImagesClient is the compute Client
type VirtualMachineImagesClient struct {
BaseClient
}
func NewVirtualMachineImagesClient(subscriptionID string) VirtualMachineImagesClient
NewVirtualMachineImagesClient creates an instance of the VirtualMachineImagesClient client.
func NewVirtualMachineImagesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineImagesClient
NewVirtualMachineImagesClientWithBaseURI creates an instance of the VirtualMachineImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineImagesClient) Get(ctx context.Context, location string, publisherName string, offer string, skus string, version string) (result VirtualMachineImage, err error)
Get gets a virtual machine image. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer. skus - a valid image SKU. version - a valid image SKU version.
func (client VirtualMachineImagesClient) GetPreparer(ctx context.Context, location string, publisherName string, offer string, skus string, version string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineImagesClient) GetResponder(resp *http.Response) (result VirtualMachineImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) List(ctx context.Context, location string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (result ListVirtualMachineImageResource, err error)
List gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer. skus - a valid image SKU. expand - the expand expression to apply on the operation.
func (client VirtualMachineImagesClient) ListOffers(ctx context.Context, location string, publisherName string) (result ListVirtualMachineImageResource, err error)
ListOffers gets a list of virtual machine image offers for the specified location and publisher. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher.
func (client VirtualMachineImagesClient) ListOffersPreparer(ctx context.Context, location string, publisherName string) (*http.Request, error)
ListOffersPreparer prepares the ListOffers request.
func (client VirtualMachineImagesClient) ListOffersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListOffersResponder handles the response to the ListOffers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListOffersSender(req *http.Request) (*http.Response, error)
ListOffersSender sends the ListOffers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListPreparer(ctx context.Context, location string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineImagesClient) ListPublishers(ctx context.Context, location string) (result ListVirtualMachineImageResource, err error)
ListPublishers gets a list of virtual machine image publishers for the specified Azure location. Parameters: location - the name of a supported Azure region.
func (client VirtualMachineImagesClient) ListPublishersPreparer(ctx context.Context, location string) (*http.Request, error)
ListPublishersPreparer prepares the ListPublishers request.
func (client VirtualMachineImagesClient) ListPublishersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListPublishersResponder handles the response to the ListPublishers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListPublishersSender(req *http.Request) (*http.Response, error)
ListPublishersSender sends the ListPublishers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesClient) ListSkus(ctx context.Context, location string, publisherName string, offer string) (result ListVirtualMachineImageResource, err error)
ListSkus gets a list of virtual machine image SKUs for the specified location, publisher, and offer. Parameters: location - the name of a supported Azure region. publisherName - a valid image publisher. offer - a valid image publisher offer.
func (client VirtualMachineImagesClient) ListSkusPreparer(ctx context.Context, location string, publisherName string, offer string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (client VirtualMachineImagesClient) ListSkusResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.
func (client VirtualMachineImagesClient) ListSkusSender(req *http.Request) (*http.Response, error)
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
VirtualMachineImagesEdgeZoneClient is the compute Client
type VirtualMachineImagesEdgeZoneClient struct {
BaseClient
}
func NewVirtualMachineImagesEdgeZoneClient(subscriptionID string) VirtualMachineImagesEdgeZoneClient
NewVirtualMachineImagesEdgeZoneClient creates an instance of the VirtualMachineImagesEdgeZoneClient client.
func NewVirtualMachineImagesEdgeZoneClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineImagesEdgeZoneClient
NewVirtualMachineImagesEdgeZoneClientWithBaseURI creates an instance of the VirtualMachineImagesEdgeZoneClient 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 VirtualMachineImagesEdgeZoneClient) Get(ctx context.Context, location string, edgeZone string, publisherName string, offer string, skus string, version string) (result VirtualMachineImage, err error)
Get gets a virtual machine image in an edge zone. Parameters: location - the name of a supported Azure region. edgeZone - the name of the edge zone. publisherName - a valid image publisher. offer - a valid image publisher offer. skus - a valid image SKU. version - a valid image SKU version.
func (client VirtualMachineImagesEdgeZoneClient) GetPreparer(ctx context.Context, location string, edgeZone string, publisherName string, offer string, skus string, version string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineImagesEdgeZoneClient) GetResponder(resp *http.Response) (result VirtualMachineImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineImagesEdgeZoneClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesEdgeZoneClient) List(ctx context.Context, location string, edgeZone string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (result ListVirtualMachineImageResource, err error)
List gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU. Parameters: location - the name of a supported Azure region. edgeZone - the name of the edge zone. publisherName - a valid image publisher. offer - a valid image publisher offer. skus - a valid image SKU. expand - the expand expression to apply on the operation. top - an integer value specifying the number of images to return that matches supplied values. orderby - specifies the order of the results returned. Formatted as an OData query.
func (client VirtualMachineImagesEdgeZoneClient) ListOffers(ctx context.Context, location string, edgeZone string, publisherName string) (result ListVirtualMachineImageResource, err error)
ListOffers gets a list of virtual machine image offers for the specified location, edge zone and publisher. Parameters: location - the name of a supported Azure region. edgeZone - the name of the edge zone. publisherName - a valid image publisher.
func (client VirtualMachineImagesEdgeZoneClient) ListOffersPreparer(ctx context.Context, location string, edgeZone string, publisherName string) (*http.Request, error)
ListOffersPreparer prepares the ListOffers request.
func (client VirtualMachineImagesEdgeZoneClient) ListOffersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListOffersResponder handles the response to the ListOffers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesEdgeZoneClient) ListOffersSender(req *http.Request) (*http.Response, error)
ListOffersSender sends the ListOffers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesEdgeZoneClient) ListPreparer(ctx context.Context, location string, edgeZone string, publisherName string, offer string, skus string, expand string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineImagesEdgeZoneClient) ListPublishers(ctx context.Context, location string, edgeZone string) (result ListVirtualMachineImageResource, err error)
ListPublishers gets a list of virtual machine image publishers for the specified Azure location and edge zone. Parameters: location - the name of a supported Azure region. edgeZone - the name of the edge zone.
func (client VirtualMachineImagesEdgeZoneClient) ListPublishersPreparer(ctx context.Context, location string, edgeZone string) (*http.Request, error)
ListPublishersPreparer prepares the ListPublishers request.
func (client VirtualMachineImagesEdgeZoneClient) ListPublishersResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListPublishersResponder handles the response to the ListPublishers request. The method always closes the http.Response Body.
func (client VirtualMachineImagesEdgeZoneClient) ListPublishersSender(req *http.Request) (*http.Response, error)
ListPublishersSender sends the ListPublishers request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesEdgeZoneClient) ListResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineImagesEdgeZoneClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineImagesEdgeZoneClient) ListSkus(ctx context.Context, location string, edgeZone string, publisherName string, offer string) (result ListVirtualMachineImageResource, err error)
ListSkus gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer. Parameters: location - the name of a supported Azure region. edgeZone - the name of the edge zone. publisherName - a valid image publisher. offer - a valid image publisher offer.
func (client VirtualMachineImagesEdgeZoneClient) ListSkusPreparer(ctx context.Context, location string, edgeZone string, publisherName string, offer string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (client VirtualMachineImagesEdgeZoneClient) ListSkusResponder(resp *http.Response) (result ListVirtualMachineImageResource, err error)
ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.
func (client VirtualMachineImagesEdgeZoneClient) ListSkusSender(req *http.Request) (*http.Response, error)
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
VirtualMachineInstallPatchesParameters input for InstallPatches as directly received by the API
type VirtualMachineInstallPatchesParameters struct {
// MaximumDuration - Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)
MaximumDuration *string `json:"maximumDuration,omitempty"`
// RebootSetting - Defines when it is acceptable to reboot a VM during a software update operation. Possible values include: 'VMGuestPatchRebootSettingIfRequired', 'VMGuestPatchRebootSettingNever', 'VMGuestPatchRebootSettingAlways'
RebootSetting VMGuestPatchRebootSetting `json:"rebootSetting,omitempty"`
// WindowsParameters - Input for InstallPatches on a Windows VM, as directly received by the API
WindowsParameters *WindowsParameters `json:"windowsParameters,omitempty"`
// LinuxParameters - Input for InstallPatches on a Linux VM, as directly received by the API
LinuxParameters *LinuxParameters `json:"linuxParameters,omitempty"`
}
VirtualMachineInstallPatchesResult the result summary of an installation operation.
type VirtualMachineInstallPatchesResult struct {
autorest.Response `json:"-"`
// Status - READ-ONLY; The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings.". Possible values include: 'PatchOperationStatusUnknown', 'PatchOperationStatusInProgress', 'PatchOperationStatusFailed', 'PatchOperationStatusSucceeded', 'PatchOperationStatusCompletedWithWarnings'
Status PatchOperationStatus `json:"status,omitempty"`
// InstallationActivityID - READ-ONLY; The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
InstallationActivityID *string `json:"installationActivityId,omitempty"`
// RebootStatus - READ-ONLY; The reboot state of the VM following completion of the operation. Possible values include: 'VMGuestPatchRebootStatusUnknown', 'VMGuestPatchRebootStatusNotNeeded', 'VMGuestPatchRebootStatusRequired', 'VMGuestPatchRebootStatusStarted', 'VMGuestPatchRebootStatusFailed', 'VMGuestPatchRebootStatusCompleted'
RebootStatus VMGuestPatchRebootStatus `json:"rebootStatus,omitempty"`
// MaintenanceWindowExceeded - READ-ONLY; Whether the operation ran out of time before it completed all its intended actions.
MaintenanceWindowExceeded *bool `json:"maintenanceWindowExceeded,omitempty"`
// ExcludedPatchCount - READ-ONLY; The number of patches that were not installed due to the user blocking their installation.
ExcludedPatchCount *int32 `json:"excludedPatchCount,omitempty"`
// NotSelectedPatchCount - READ-ONLY; The number of patches that were detected as available for install, but did not meet the operation's criteria.
NotSelectedPatchCount *int32 `json:"notSelectedPatchCount,omitempty"`
// PendingPatchCount - READ-ONLY; The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true.
PendingPatchCount *int32 `json:"pendingPatchCount,omitempty"`
// InstalledPatchCount - READ-ONLY; The number of patches successfully installed.
InstalledPatchCount *int32 `json:"installedPatchCount,omitempty"`
// FailedPatchCount - READ-ONLY; The number of patches that could not be installed due to some issue. See errors for details.
FailedPatchCount *int32 `json:"failedPatchCount,omitempty"`
// Patches - READ-ONLY; The patches that were installed during the operation.
Patches *[]PatchInstallationDetail `json:"patches,omitempty"`
// StartDateTime - READ-ONLY; The UTC timestamp when the operation began.
StartDateTime *date.Time `json:"startDateTime,omitempty"`
// Error - READ-ONLY; The errors that were encountered during execution of the operation. The details array contains the list of them.
Error *APIError `json:"error,omitempty"`
}
func (vmipr VirtualMachineInstallPatchesResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineInstallPatchesResult.
VirtualMachineInstanceView the instance view of a virtual machine.
type VirtualMachineInstanceView struct {
autorest.Response `json:"-"`
// PlatformUpdateDomain - Specifies the update domain of the virtual machine.
PlatformUpdateDomain *int32 `json:"platformUpdateDomain,omitempty"`
// PlatformFaultDomain - Specifies the fault domain of the virtual machine.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// ComputerName - The computer name assigned to the virtual machine.
ComputerName *string `json:"computerName,omitempty"`
// OsName - The Operating System running on the virtual machine.
OsName *string `json:"osName,omitempty"`
// OsVersion - The version of Operating System running on the virtual machine.
OsVersion *string `json:"osVersion,omitempty"`
// HyperVGeneration - Specifies the HyperVGeneration Type associated with a resource. Possible values include: 'HyperVGenerationTypeV1', 'HyperVGenerationTypeV2'
HyperVGeneration HyperVGenerationType `json:"hyperVGeneration,omitempty"`
// RdpThumbPrint - The Remote desktop certificate thumbprint.
RdpThumbPrint *string `json:"rdpThumbPrint,omitempty"`
// VMAgent - The VM Agent running on the virtual machine.
VMAgent *VirtualMachineAgentInstanceView `json:"vmAgent,omitempty"`
// MaintenanceRedeployStatus - The Maintenance Operation status on the virtual machine.
MaintenanceRedeployStatus *MaintenanceRedeployStatus `json:"maintenanceRedeployStatus,omitempty"`
// Disks - The virtual machine disk information.
Disks *[]DiskInstanceView `json:"disks,omitempty"`
// Extensions - The extensions information.
Extensions *[]VirtualMachineExtensionInstanceView `json:"extensions,omitempty"`
// VMHealth - READ-ONLY; The health status for the VM.
VMHealth *VirtualMachineHealthStatus `json:"vmHealth,omitempty"`
// BootDiagnostics - Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.
BootDiagnostics *BootDiagnosticsInstanceView `json:"bootDiagnostics,omitempty"`
// AssignedHost - READ-ONLY; Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. <br><br>Minimum api-version: 2020-06-01.
AssignedHost *string `json:"assignedHost,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
// PatchStatus - [Preview Feature] The status of virtual machine patch operations.
PatchStatus *VirtualMachinePatchStatus `json:"patchStatus,omitempty"`
}
func (vmiv VirtualMachineInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineInstanceView.
VirtualMachineListResult the List Virtual Machine operation response.
type VirtualMachineListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machines.
Value *[]VirtualMachine `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmlr VirtualMachineListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineListResultIterator provides access to a complete listing of VirtualMachine values.
type VirtualMachineListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineListResultIterator(page VirtualMachineListResultPage) VirtualMachineListResultIterator
Creates a new instance of the VirtualMachineListResultIterator type.
func (iter *VirtualMachineListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineListResultIterator) Response() VirtualMachineListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineListResultIterator) Value() VirtualMachine
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineListResultPage contains a page of VirtualMachine values.
type VirtualMachineListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineListResultPage(cur VirtualMachineListResult, getNextPage func(context.Context, VirtualMachineListResult) (VirtualMachineListResult, error)) VirtualMachineListResultPage
Creates a new instance of the VirtualMachineListResultPage type.
func (page *VirtualMachineListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineListResultPage) Response() VirtualMachineListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineListResultPage) Values() []VirtualMachine
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineNetworkInterfaceConfiguration describes a virtual machine network interface configurations.
type VirtualMachineNetworkInterfaceConfiguration struct {
// Name - The network interface configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineNetworkInterfaceConfigurationProperties `json:"properties,omitempty"`
}
func (vmnic VirtualMachineNetworkInterfaceConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineNetworkInterfaceConfiguration.
func (vmnic *VirtualMachineNetworkInterfaceConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineNetworkInterfaceConfiguration struct.
VirtualMachineNetworkInterfaceConfigurationProperties describes a virtual machine network profile's IP configuration.
type VirtualMachineNetworkInterfaceConfigurationProperties struct {
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// DeleteOption - Specify what happens to the network interface when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
// EnableAcceleratedNetworking - Specifies whether the network interface is accelerated networking-enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// EnableFpga - Specifies whether the network interface is FPGA networking-enabled.
EnableFpga *bool `json:"enableFpga,omitempty"`
// EnableIPForwarding - Whether IP forwarding enabled on this NIC.
EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`
// NetworkSecurityGroup - The network security group.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
// DNSSettings - The dns settings to be applied on the network interfaces.
DNSSettings *VirtualMachineNetworkInterfaceDNSSettingsConfiguration `json:"dnsSettings,omitempty"`
// IPConfigurations - Specifies the IP configurations of the network interface.
IPConfigurations *[]VirtualMachineNetworkInterfaceIPConfiguration `json:"ipConfigurations,omitempty"`
DscpConfiguration *SubResource `json:"dscpConfiguration,omitempty"`
}
VirtualMachineNetworkInterfaceDNSSettingsConfiguration describes a virtual machines network configuration's DNS settings.
type VirtualMachineNetworkInterfaceDNSSettingsConfiguration struct {
// DNSServers - List of DNS servers IP addresses
DNSServers *[]string `json:"dnsServers,omitempty"`
}
VirtualMachineNetworkInterfaceIPConfiguration describes a virtual machine network profile's IP configuration.
type VirtualMachineNetworkInterfaceIPConfiguration struct {
// Name - The IP configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineNetworkInterfaceIPConfigurationProperties `json:"properties,omitempty"`
}
func (vmniic VirtualMachineNetworkInterfaceIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineNetworkInterfaceIPConfiguration.
func (vmniic *VirtualMachineNetworkInterfaceIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineNetworkInterfaceIPConfiguration struct.
VirtualMachineNetworkInterfaceIPConfigurationProperties describes a virtual machine network interface IP configuration properties.
type VirtualMachineNetworkInterfaceIPConfigurationProperties struct {
// Subnet - Specifies the identifier of the subnet.
Subnet *SubResource `json:"subnet,omitempty"`
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// PublicIPAddressConfiguration - The publicIPAddressConfiguration.
PublicIPAddressConfiguration *VirtualMachinePublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPVersionsIPv4', 'IPVersionsIPv6'
PrivateIPAddressVersion IPVersions `json:"privateIPAddressVersion,omitempty"`
// ApplicationSecurityGroups - Specifies an array of references to application security group.
ApplicationSecurityGroups *[]SubResource `json:"applicationSecurityGroups,omitempty"`
// ApplicationGatewayBackendAddressPools - Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.
ApplicationGatewayBackendAddressPools *[]SubResource `json:"applicationGatewayBackendAddressPools,omitempty"`
// LoadBalancerBackendAddressPools - Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].
LoadBalancerBackendAddressPools *[]SubResource `json:"loadBalancerBackendAddressPools,omitempty"`
}
VirtualMachinePatchStatus the status of virtual machine patch operations.
type VirtualMachinePatchStatus struct {
// AvailablePatchSummary - The available patch summary of the latest assessment operation for the virtual machine.
AvailablePatchSummary *AvailablePatchSummary `json:"availablePatchSummary,omitempty"`
// LastPatchInstallationSummary - The installation summary of the latest installation operation for the virtual machine.
LastPatchInstallationSummary *LastPatchInstallationSummary `json:"lastPatchInstallationSummary,omitempty"`
// ConfigurationStatuses - READ-ONLY; The enablement status of the specified patchMode
ConfigurationStatuses *[]InstanceViewStatus `json:"configurationStatuses,omitempty"`
}
func (vmps VirtualMachinePatchStatus) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachinePatchStatus.
VirtualMachinePriorityTypes enumerates the values for virtual machine priority types.
type VirtualMachinePriorityTypes string
const (
// VirtualMachinePriorityTypesLow ...
VirtualMachinePriorityTypesLow VirtualMachinePriorityTypes = "Low"
// VirtualMachinePriorityTypesRegular ...
VirtualMachinePriorityTypesRegular VirtualMachinePriorityTypes = "Regular"
// VirtualMachinePriorityTypesSpot ...
VirtualMachinePriorityTypesSpot VirtualMachinePriorityTypes = "Spot"
)
func PossibleVirtualMachinePriorityTypesValues() []VirtualMachinePriorityTypes
PossibleVirtualMachinePriorityTypesValues returns an array of possible values for the VirtualMachinePriorityTypes const type.
VirtualMachineProperties describes the properties of a Virtual Machine.
type VirtualMachineProperties struct {
// HardwareProfile - Specifies the hardware settings for the virtual machine.
HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *StorageProfile `json:"storageProfile,omitempty"`
// AdditionalCapabilities - Specifies additional capabilities enabled or disabled on the virtual machine.
AdditionalCapabilities *AdditionalCapabilities `json:"additionalCapabilities,omitempty"`
// OsProfile - Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
OsProfile *OSProfile `json:"osProfile,omitempty"`
// NetworkProfile - Specifies the network interfaces of the virtual machine.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// SecurityProfile - Specifies the Security related profile settings for the virtual machine.
SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// AvailabilitySet - Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
AvailabilitySet *SubResource `json:"availabilitySet,omitempty"`
// VirtualMachineScaleSet - Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01
VirtualMachineScaleSet *SubResource `json:"virtualMachineScaleSet,omitempty"`
// ProximityPlacementGroup - Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01.
ProximityPlacementGroup *SubResource `json:"proximityPlacementGroup,omitempty"`
// Priority - Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01. Possible values include: 'VirtualMachinePriorityTypesRegular', 'VirtualMachinePriorityTypesLow', 'VirtualMachinePriorityTypesSpot'
Priority VirtualMachinePriorityTypes `json:"priority,omitempty"`
// EvictionPolicy - Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'VirtualMachineEvictionPolicyTypesDeallocate', 'VirtualMachineEvictionPolicyTypesDelete'
EvictionPolicy VirtualMachineEvictionPolicyTypes `json:"evictionPolicy,omitempty"`
// BillingProfile - Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01.
BillingProfile *BillingProfile `json:"billingProfile,omitempty"`
// Host - Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01.
Host *SubResource `json:"host,omitempty"`
// HostGroup - Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties.
HostGroup *SubResource `json:"hostGroup,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - READ-ONLY; The virtual machine instance view.
InstanceView *VirtualMachineInstanceView `json:"instanceView,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
// VMID - READ-ONLY; Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
VMID *string `json:"vmId,omitempty"`
// ExtensionsTimeBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01
ExtensionsTimeBudget *string `json:"extensionsTimeBudget,omitempty"`
// PlatformFaultDomain - Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// ScheduledEventsProfile - Specifies Scheduled Event related configurations.
ScheduledEventsProfile *ScheduledEventsProfile `json:"scheduledEventsProfile,omitempty"`
// UserData - UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01
UserData *string `json:"userData,omitempty"`
// CapacityReservation - Specifies information about the capacity reservation that is used to allocate virtual machine. <br><br>Minimum api-version: 2021-04-01.
CapacityReservation *CapacityReservationProfile `json:"capacityReservation,omitempty"`
// ApplicationProfile - Specifies the gallery applications that should be made available to the VM/VMSS
ApplicationProfile *ApplicationProfile `json:"applicationProfile,omitempty"`
// TimeCreated - READ-ONLY; Specifies the time at which the Virtual Machine resource was created.<br><br>Minimum api-version: 2021-11-01.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
}
func (vmp VirtualMachineProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineProperties.
VirtualMachinePublicIPAddressConfiguration describes a virtual machines IP Configuration's PublicIPAddress configuration
type VirtualMachinePublicIPAddressConfiguration struct {
// Name - The publicIP address configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachinePublicIPAddressConfigurationProperties `json:"properties,omitempty"`
Sku *PublicIPAddressSku `json:"sku,omitempty"`
}
func (vmpiac VirtualMachinePublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachinePublicIPAddressConfiguration.
func (vmpiac *VirtualMachinePublicIPAddressConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachinePublicIPAddressConfiguration struct.
VirtualMachinePublicIPAddressConfigurationProperties describes a virtual machines IP Configuration's PublicIPAddress configuration
type VirtualMachinePublicIPAddressConfigurationProperties struct {
// IdleTimeoutInMinutes - The idle timeout of the public IP address.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// DeleteOption - Specify what happens to the public IP address when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
// DNSSettings - The dns settings to be applied on the publicIP addresses .
DNSSettings *VirtualMachinePublicIPAddressDNSSettingsConfiguration `json:"dnsSettings,omitempty"`
// IPTags - The list of IP tags associated with the public IP address.
IPTags *[]VirtualMachineIPTag `json:"ipTags,omitempty"`
// PublicIPPrefix - The PublicIPPrefix from which to allocate publicIP addresses.
PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`
// PublicIPAddressVersion - Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPVersionsIPv4', 'IPVersionsIPv6'
PublicIPAddressVersion IPVersions `json:"publicIPAddressVersion,omitempty"`
// PublicIPAllocationMethod - Specify the public IP allocation type. Possible values include: 'PublicIPAllocationMethodDynamic', 'PublicIPAllocationMethodStatic'
PublicIPAllocationMethod PublicIPAllocationMethod `json:"publicIPAllocationMethod,omitempty"`
}
VirtualMachinePublicIPAddressDNSSettingsConfiguration describes a virtual machines network configuration's DNS settings.
type VirtualMachinePublicIPAddressDNSSettingsConfiguration struct {
// DomainNameLabel - The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.
DomainNameLabel *string `json:"domainNameLabel,omitempty"`
}
VirtualMachineReimageParameters parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged
type VirtualMachineReimageParameters struct {
// TempDisk - Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
TempDisk *bool `json:"tempDisk,omitempty"`
}
VirtualMachineRunCommand describes a Virtual Machine run command.
type VirtualMachineRunCommand struct {
autorest.Response `json:"-"`
*VirtualMachineRunCommandProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmrc VirtualMachineRunCommand) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineRunCommand.
func (vmrc *VirtualMachineRunCommand) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineRunCommand struct.
VirtualMachineRunCommandInstanceView the instance view of a virtual machine run command.
type VirtualMachineRunCommandInstanceView struct {
// ExecutionState - Script execution status. Possible values include: 'ExecutionStateUnknown', 'ExecutionStatePending', 'ExecutionStateRunning', 'ExecutionStateFailed', 'ExecutionStateSucceeded', 'ExecutionStateTimedOut', 'ExecutionStateCanceled'
ExecutionState ExecutionState `json:"executionState,omitempty"`
// ExecutionMessage - Communicate script configuration errors or execution messages.
ExecutionMessage *string `json:"executionMessage,omitempty"`
// ExitCode - Exit code returned from script execution.
ExitCode *int32 `json:"exitCode,omitempty"`
// Output - Script output stream.
Output *string `json:"output,omitempty"`
// Error - Script error stream.
Error *string `json:"error,omitempty"`
// StartTime - Script start time.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - Script end time.
EndTime *date.Time `json:"endTime,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}
VirtualMachineRunCommandProperties describes the properties of a Virtual Machine run command.
type VirtualMachineRunCommandProperties struct {
// Source - The source of the run command script.
Source *VirtualMachineRunCommandScriptSource `json:"source,omitempty"`
// Parameters - The parameters used by the script.
Parameters *[]RunCommandInputParameter `json:"parameters,omitempty"`
// ProtectedParameters - The parameters used by the script.
ProtectedParameters *[]RunCommandInputParameter `json:"protectedParameters,omitempty"`
// AsyncExecution - Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
AsyncExecution *bool `json:"asyncExecution,omitempty"`
// RunAsUser - Specifies the user account on the VM when executing the run command.
RunAsUser *string `json:"runAsUser,omitempty"`
// RunAsPassword - Specifies the user account password on the VM when executing the run command.
RunAsPassword *string `json:"runAsPassword,omitempty"`
// TimeoutInSeconds - The timeout in seconds to execute the run command.
TimeoutInSeconds *int32 `json:"timeoutInSeconds,omitempty"`
// OutputBlobURI - Specifies the Azure storage blob where script output stream will be uploaded.
OutputBlobURI *string `json:"outputBlobUri,omitempty"`
// ErrorBlobURI - Specifies the Azure storage blob where script error stream will be uploaded.
ErrorBlobURI *string `json:"errorBlobUri,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// InstanceView - READ-ONLY; The virtual machine run command instance view.
InstanceView *VirtualMachineRunCommandInstanceView `json:"instanceView,omitempty"`
}
func (vmrcp VirtualMachineRunCommandProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineRunCommandProperties.
VirtualMachineRunCommandScriptSource describes the script sources for run command.
type VirtualMachineRunCommandScriptSource struct {
// Script - Specifies the script content to be executed on the VM.
Script *string `json:"script,omitempty"`
// ScriptURI - Specifies the script download location.
ScriptURI *string `json:"scriptUri,omitempty"`
// CommandID - Specifies a commandId of predefined built-in script.
CommandID *string `json:"commandId,omitempty"`
}
VirtualMachineRunCommandUpdate describes a Virtual Machine run command.
type VirtualMachineRunCommandUpdate struct {
*VirtualMachineRunCommandProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmrcu VirtualMachineRunCommandUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineRunCommandUpdate.
func (vmrcu *VirtualMachineRunCommandUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineRunCommandUpdate struct.
VirtualMachineRunCommandsClient is the compute Client
type VirtualMachineRunCommandsClient struct {
BaseClient
}
func NewVirtualMachineRunCommandsClient(subscriptionID string) VirtualMachineRunCommandsClient
NewVirtualMachineRunCommandsClient creates an instance of the VirtualMachineRunCommandsClient client.
func NewVirtualMachineRunCommandsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineRunCommandsClient
NewVirtualMachineRunCommandsClientWithBaseURI creates an instance of the VirtualMachineRunCommandsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineRunCommandsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, runCommand VirtualMachineRunCommand) (result VirtualMachineRunCommandsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update the run command. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the run command should be created or updated. runCommandName - the name of the virtual machine run command. runCommand - parameters supplied to the Create Virtual Machine RunCommand operation.
func (client VirtualMachineRunCommandsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, runCommand VirtualMachineRunCommand) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineRunCommandsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineRunCommandsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) Delete(ctx context.Context, resourceGroupName string, VMName string, runCommandName string) (result VirtualMachineRunCommandsDeleteFuture, err error)
Delete the operation to delete the run command. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the run command should be deleted. runCommandName - the name of the virtual machine run command.
func (client VirtualMachineRunCommandsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMName string, runCommandName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineRunCommandsClient) 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 VirtualMachineRunCommandsClient) DeleteSender(req *http.Request) (future VirtualMachineRunCommandsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) Get(ctx context.Context, location string, commandID string) (result RunCommandDocument, err error)
Get gets specific run command for a subscription in a location. Parameters: location - the location upon which run commands is queried. commandID - the command id.
func (client VirtualMachineRunCommandsClient) GetByVirtualMachine(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, expand string) (result VirtualMachineRunCommand, err error)
GetByVirtualMachine the operation to get the run command. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the run command. runCommandName - the name of the virtual machine run command. expand - the expand expression to apply on the operation.
func (client VirtualMachineRunCommandsClient) GetByVirtualMachinePreparer(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, expand string) (*http.Request, error)
GetByVirtualMachinePreparer prepares the GetByVirtualMachine request.
func (client VirtualMachineRunCommandsClient) GetByVirtualMachineResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
GetByVirtualMachineResponder handles the response to the GetByVirtualMachine request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) GetByVirtualMachineSender(req *http.Request) (*http.Response, error)
GetByVirtualMachineSender sends the GetByVirtualMachine request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) GetPreparer(ctx context.Context, location string, commandID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineRunCommandsClient) GetResponder(resp *http.Response) (result RunCommandDocument, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) List(ctx context.Context, location string) (result RunCommandListResultPage, err error)
List lists all available run commands for a subscription in a location. Parameters: location - the location upon which run commands is queried.
func (client VirtualMachineRunCommandsClient) ListByVirtualMachine(ctx context.Context, resourceGroupName string, VMName string, expand string) (result VirtualMachineRunCommandsListResultPage, err error)
ListByVirtualMachine the operation to get all run commands of a Virtual Machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine containing the run command. expand - the expand expression to apply on the operation.
func (client VirtualMachineRunCommandsClient) ListByVirtualMachineComplete(ctx context.Context, resourceGroupName string, VMName string, expand string) (result VirtualMachineRunCommandsListResultIterator, err error)
ListByVirtualMachineComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineRunCommandsClient) ListByVirtualMachinePreparer(ctx context.Context, resourceGroupName string, VMName string, expand string) (*http.Request, error)
ListByVirtualMachinePreparer prepares the ListByVirtualMachine request.
func (client VirtualMachineRunCommandsClient) ListByVirtualMachineResponder(resp *http.Response) (result VirtualMachineRunCommandsListResult, err error)
ListByVirtualMachineResponder handles the response to the ListByVirtualMachine request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) ListByVirtualMachineSender(req *http.Request) (*http.Response, error)
ListByVirtualMachineSender sends the ListByVirtualMachine request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) ListComplete(ctx context.Context, location string) (result RunCommandListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineRunCommandsClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineRunCommandsClient) ListResponder(resp *http.Response) (result RunCommandListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineRunCommandsClient) Update(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, runCommand VirtualMachineRunCommandUpdate) (result VirtualMachineRunCommandsUpdateFuture, err error)
Update the operation to update the run command. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine where the run command should be updated. runCommandName - the name of the virtual machine run command. runCommand - parameters supplied to the Update Virtual Machine RunCommand operation.
func (client VirtualMachineRunCommandsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, runCommandName string, runCommand VirtualMachineRunCommandUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineRunCommandsClient) UpdateResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineRunCommandsClient) UpdateSender(req *http.Request) (future VirtualMachineRunCommandsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineRunCommandsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineRunCommandsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineRunCommandsClient) (VirtualMachineRunCommand, error)
}
func (future *VirtualMachineRunCommandsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineRunCommandsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineRunCommandsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineRunCommandsClient) (autorest.Response, error)
}
func (future *VirtualMachineRunCommandsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineRunCommandsListResult the List run command operation response
type VirtualMachineRunCommandsListResult struct {
autorest.Response `json:"-"`
// Value - The list of run commands
Value *[]VirtualMachineRunCommand `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of run commands.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmrclr VirtualMachineRunCommandsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineRunCommandsListResultIterator provides access to a complete listing of VirtualMachineRunCommand values.
type VirtualMachineRunCommandsListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineRunCommandsListResultIterator(page VirtualMachineRunCommandsListResultPage) VirtualMachineRunCommandsListResultIterator
Creates a new instance of the VirtualMachineRunCommandsListResultIterator type.
func (iter *VirtualMachineRunCommandsListResultIterator) 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 *VirtualMachineRunCommandsListResultIterator) 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 VirtualMachineRunCommandsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineRunCommandsListResultIterator) Response() VirtualMachineRunCommandsListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineRunCommandsListResultIterator) Value() VirtualMachineRunCommand
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineRunCommandsListResultPage contains a page of VirtualMachineRunCommand values.
type VirtualMachineRunCommandsListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineRunCommandsListResultPage(cur VirtualMachineRunCommandsListResult, getNextPage func(context.Context, VirtualMachineRunCommandsListResult) (VirtualMachineRunCommandsListResult, error)) VirtualMachineRunCommandsListResultPage
Creates a new instance of the VirtualMachineRunCommandsListResultPage type.
func (page *VirtualMachineRunCommandsListResultPage) 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 *VirtualMachineRunCommandsListResultPage) 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 VirtualMachineRunCommandsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineRunCommandsListResultPage) Response() VirtualMachineRunCommandsListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineRunCommandsListResultPage) Values() []VirtualMachineRunCommand
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineRunCommandsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineRunCommandsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineRunCommandsClient) (VirtualMachineRunCommand, error)
}
func (future *VirtualMachineRunCommandsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSet describes a Virtual Machine Scale Set.
type VirtualMachineScaleSet struct {
autorest.Response `json:"-"`
// Sku - The virtual machine scale set sku.
Sku *Sku `json:"sku,omitempty"`
// Plan - Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineScaleSetProperties `json:"properties,omitempty"`
// Identity - The identity of the virtual machine scale set, if configured.
Identity *VirtualMachineScaleSetIdentity `json:"identity,omitempty"`
// Zones - The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set
Zones *[]string `json:"zones,omitempty"`
// ExtendedLocation - The extended location of the Virtual Machine Scale Set.
ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmss VirtualMachineScaleSet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSet.
func (vmss *VirtualMachineScaleSet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSet struct.
VirtualMachineScaleSetDataDisk describes a virtual machine scale set data disk.
type VirtualMachineScaleSetDataDisk struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// CreateOption - The create option. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiskSizeGB - Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
// DiskIOPSReadWrite - Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
DiskMBpsReadWrite *int64 `json:"diskMBpsReadWrite,omitempty"`
}
VirtualMachineScaleSetExtension describes a Virtual Machine Scale Set Extension.
type VirtualMachineScaleSetExtension struct {
autorest.Response `json:"-"`
// Name - The name of the extension.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*VirtualMachineScaleSetExtensionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (vmsse VirtualMachineScaleSetExtension) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetExtension.
func (vmsse *VirtualMachineScaleSetExtension) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetExtension struct.
VirtualMachineScaleSetExtensionListResult the List VM scale set extension operation response.
type VirtualMachineScaleSetExtensionListResult struct {
autorest.Response `json:"-"`
// Value - The list of VM scale set extensions.
Value *[]VirtualMachineScaleSetExtension `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsselr VirtualMachineScaleSetExtensionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetExtensionListResultIterator provides access to a complete listing of VirtualMachineScaleSetExtension values.
type VirtualMachineScaleSetExtensionListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetExtensionListResultIterator(page VirtualMachineScaleSetExtensionListResultPage) VirtualMachineScaleSetExtensionListResultIterator
Creates a new instance of the VirtualMachineScaleSetExtensionListResultIterator type.
func (iter *VirtualMachineScaleSetExtensionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineScaleSetExtensionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineScaleSetExtensionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetExtensionListResultIterator) Response() VirtualMachineScaleSetExtensionListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetExtensionListResultIterator) Value() VirtualMachineScaleSetExtension
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetExtensionListResultPage contains a page of VirtualMachineScaleSetExtension values.
type VirtualMachineScaleSetExtensionListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetExtensionListResultPage(cur VirtualMachineScaleSetExtensionListResult, getNextPage func(context.Context, VirtualMachineScaleSetExtensionListResult) (VirtualMachineScaleSetExtensionListResult, error)) VirtualMachineScaleSetExtensionListResultPage
Creates a new instance of the VirtualMachineScaleSetExtensionListResultPage type.
func (page *VirtualMachineScaleSetExtensionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineScaleSetExtensionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineScaleSetExtensionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetExtensionListResultPage) Response() VirtualMachineScaleSetExtensionListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetExtensionListResultPage) Values() []VirtualMachineScaleSetExtension
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetExtensionProfile describes a virtual machine scale set extension profile.
type VirtualMachineScaleSetExtensionProfile struct {
// Extensions - The virtual machine scale set child extension resources.
Extensions *[]VirtualMachineScaleSetExtension `json:"extensions,omitempty"`
// ExtensionsTimeBudget - Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01
ExtensionsTimeBudget *string `json:"extensionsTimeBudget,omitempty"`
}
VirtualMachineScaleSetExtensionProperties describes the properties of a Virtual Machine Scale Set Extension.
type VirtualMachineScaleSetExtensionProperties struct {
// ForceUpdateTag - If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
ForceUpdateTag *string `json:"forceUpdateTag,omitempty"`
// Publisher - The name of the extension handler publisher.
Publisher *string `json:"publisher,omitempty"`
// Type - Specifies the type of the extension; an example is "CustomScriptExtension".
Type *string `json:"type,omitempty"`
// TypeHandlerVersion - Specifies the version of the script handler.
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
// EnableAutomaticUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
EnableAutomaticUpgrade *bool `json:"enableAutomaticUpgrade,omitempty"`
// Settings - Json formatted public settings for the extension.
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// ProvisionAfterExtensions - Collection of extension names after which this extension needs to be provisioned.
ProvisionAfterExtensions *[]string `json:"provisionAfterExtensions,omitempty"`
// SuppressFailures - Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
SuppressFailures *bool `json:"suppressFailures,omitempty"`
// ProtectedSettingsFromKeyVault - The extensions protected settings that are passed by reference, and consumed from key vault
ProtectedSettingsFromKeyVault interface{} `json:"protectedSettingsFromKeyVault,omitempty"`
}
func (vmssep VirtualMachineScaleSetExtensionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetExtensionProperties.
VirtualMachineScaleSetExtensionUpdate describes a Virtual Machine Scale Set Extension.
type VirtualMachineScaleSetExtensionUpdate struct {
// Name - READ-ONLY; The name of the extension.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*VirtualMachineScaleSetExtensionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (vmsseu VirtualMachineScaleSetExtensionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetExtensionUpdate.
func (vmsseu *VirtualMachineScaleSetExtensionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetExtensionUpdate struct.
VirtualMachineScaleSetExtensionsClient is the compute Client
type VirtualMachineScaleSetExtensionsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetExtensionsClient(subscriptionID string) VirtualMachineScaleSetExtensionsClient
NewVirtualMachineScaleSetExtensionsClient creates an instance of the VirtualMachineScaleSetExtensionsClient client.
func NewVirtualMachineScaleSetExtensionsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetExtensionsClient
NewVirtualMachineScaleSetExtensionsClientWithBaseURI creates an instance of the VirtualMachineScaleSetExtensionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtension) (result VirtualMachineScaleSetExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update an extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be create or updated. vmssExtensionName - the name of the VM scale set extension. extensionParameters - parameters supplied to the Create VM scale set Extension operation.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtension) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineScaleSetExtension, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string) (result VirtualMachineScaleSetExtensionsDeleteFuture, err error)
Delete the operation to delete the extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be deleted. vmssExtensionName - the name of the VM scale set extension.
func (client VirtualMachineScaleSetExtensionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetExtensionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetExtensionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, expand string) (result VirtualMachineScaleSetExtension, err error)
Get the operation to get the extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set containing the extension. vmssExtensionName - the name of the VM scale set extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetExtensionsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetExtensionsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSetExtension, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) List(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetExtensionListResultPage, err error)
List gets a list of all extensions in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set containing the extension.
func (client VirtualMachineScaleSetExtensionsClient) ListComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetExtensionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetExtensionsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetExtensionsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetExtensionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetExtensionsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtensionUpdate) (result VirtualMachineScaleSetExtensionsUpdateFuture, err error)
Update the operation to update an extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be updated. vmssExtensionName - the name of the VM scale set extension. extensionParameters - parameters supplied to the Update VM scale set Extension operation.
func (client VirtualMachineScaleSetExtensionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, vmssExtensionName string, extensionParameters VirtualMachineScaleSetExtensionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetExtensionsClient) UpdateResponder(resp *http.Response) (result VirtualMachineScaleSetExtension, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetExtensionsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetExtensionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetExtensionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetExtensionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetExtensionsClient) (VirtualMachineScaleSetExtension, error)
}
func (future *VirtualMachineScaleSetExtensionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetExtensionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetExtensionsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetExtensionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetExtensionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetExtensionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetExtensionsClient) (VirtualMachineScaleSetExtension, error)
}
func (future *VirtualMachineScaleSetExtensionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetHardwareProfile specifies the hardware settings for the virtual machine scale set.
type VirtualMachineScaleSetHardwareProfile struct {
// VMSizeProperties - Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details.
VMSizeProperties *VMSizeProperties `json:"vmSizeProperties,omitempty"`
}
VirtualMachineScaleSetIPConfiguration describes a virtual machine scale set network profile's IP configuration.
type VirtualMachineScaleSetIPConfiguration struct {
// Name - The IP configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetIPConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssic VirtualMachineScaleSetIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetIPConfiguration.
func (vmssic *VirtualMachineScaleSetIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetIPConfiguration struct.
VirtualMachineScaleSetIPConfigurationProperties describes a virtual machine scale set network profile's IP configuration properties.
type VirtualMachineScaleSetIPConfigurationProperties struct {
// Subnet - Specifies the identifier of the subnet.
Subnet *APIEntityReference `json:"subnet,omitempty"`
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// PublicIPAddressConfiguration - The publicIPAddressConfiguration.
PublicIPAddressConfiguration *VirtualMachineScaleSetPublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPVersionIPv4', 'IPVersionIPv6'
PrivateIPAddressVersion IPVersion `json:"privateIPAddressVersion,omitempty"`
// ApplicationGatewayBackendAddressPools - Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.
ApplicationGatewayBackendAddressPools *[]SubResource `json:"applicationGatewayBackendAddressPools,omitempty"`
// ApplicationSecurityGroups - Specifies an array of references to application security group.
ApplicationSecurityGroups *[]SubResource `json:"applicationSecurityGroups,omitempty"`
// LoadBalancerBackendAddressPools - Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.
LoadBalancerBackendAddressPools *[]SubResource `json:"loadBalancerBackendAddressPools,omitempty"`
// LoadBalancerInboundNatPools - Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.
LoadBalancerInboundNatPools *[]SubResource `json:"loadBalancerInboundNatPools,omitempty"`
}
VirtualMachineScaleSetIPTag contains the IP tag associated with the public IP address.
type VirtualMachineScaleSetIPTag struct {
// IPTagType - IP tag type. Example: FirstPartyUsage.
IPTagType *string `json:"ipTagType,omitempty"`
// Tag - IP tag associated with the public IP. Example: SQL, Storage etc.
Tag *string `json:"tag,omitempty"`
}
VirtualMachineScaleSetIdentity identity for the virtual machine scale set.
type VirtualMachineScaleSetIdentity struct {
// PrincipalID - READ-ONLY; The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
// UserAssignedIdentities - The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
UserAssignedIdentities map[string]*VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue `json:"userAssignedIdentities"`
}
func (vmssi VirtualMachineScaleSetIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetIdentity.
VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ...
type VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue struct {
// PrincipalID - READ-ONLY; The principal id of user assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// ClientID - READ-ONLY; The client id of user assigned identity.
ClientID *string `json:"clientId,omitempty"`
}
func (vmssiAiv VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue.
VirtualMachineScaleSetInstanceView the instance view of a virtual machine scale set.
type VirtualMachineScaleSetInstanceView struct {
autorest.Response `json:"-"`
// VirtualMachine - READ-ONLY; The instance view status summary for the virtual machine scale set.
VirtualMachine *VirtualMachineScaleSetInstanceViewStatusesSummary `json:"virtualMachine,omitempty"`
// Extensions - READ-ONLY; The extensions information.
Extensions *[]VirtualMachineScaleSetVMExtensionsSummary `json:"extensions,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
// OrchestrationServices - READ-ONLY; The orchestration services information.
OrchestrationServices *[]OrchestrationServiceSummary `json:"orchestrationServices,omitempty"`
}
func (vmssiv VirtualMachineScaleSetInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetInstanceView.
VirtualMachineScaleSetInstanceViewStatusesSummary instance view statuses summary for virtual machines of a virtual machine scale set.
type VirtualMachineScaleSetInstanceViewStatusesSummary struct {
// StatusesSummary - READ-ONLY; The extensions information.
StatusesSummary *[]VirtualMachineStatusCodeCount `json:"statusesSummary,omitempty"`
}
func (vmssivss VirtualMachineScaleSetInstanceViewStatusesSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetInstanceViewStatusesSummary.
VirtualMachineScaleSetListOSUpgradeHistory list of Virtual Machine Scale Set OS Upgrade History operation response.
type VirtualMachineScaleSetListOSUpgradeHistory struct {
autorest.Response `json:"-"`
// Value - The list of OS upgrades performed on the virtual machine scale set.
Value *[]UpgradeOperationHistoricalStatusInfo `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslouh VirtualMachineScaleSetListOSUpgradeHistory) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListOSUpgradeHistoryIterator provides access to a complete listing of UpgradeOperationHistoricalStatusInfo values.
type VirtualMachineScaleSetListOSUpgradeHistoryIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListOSUpgradeHistoryIterator(page VirtualMachineScaleSetListOSUpgradeHistoryPage) VirtualMachineScaleSetListOSUpgradeHistoryIterator
Creates a new instance of the VirtualMachineScaleSetListOSUpgradeHistoryIterator type.
func (iter *VirtualMachineScaleSetListOSUpgradeHistoryIterator) 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 *VirtualMachineScaleSetListOSUpgradeHistoryIterator) 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 VirtualMachineScaleSetListOSUpgradeHistoryIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListOSUpgradeHistoryIterator) Response() VirtualMachineScaleSetListOSUpgradeHistory
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListOSUpgradeHistoryIterator) Value() UpgradeOperationHistoricalStatusInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListOSUpgradeHistoryPage contains a page of UpgradeOperationHistoricalStatusInfo values.
type VirtualMachineScaleSetListOSUpgradeHistoryPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListOSUpgradeHistoryPage(cur VirtualMachineScaleSetListOSUpgradeHistory, getNextPage func(context.Context, VirtualMachineScaleSetListOSUpgradeHistory) (VirtualMachineScaleSetListOSUpgradeHistory, error)) VirtualMachineScaleSetListOSUpgradeHistoryPage
Creates a new instance of the VirtualMachineScaleSetListOSUpgradeHistoryPage type.
func (page *VirtualMachineScaleSetListOSUpgradeHistoryPage) 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 *VirtualMachineScaleSetListOSUpgradeHistoryPage) 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 VirtualMachineScaleSetListOSUpgradeHistoryPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListOSUpgradeHistoryPage) Response() VirtualMachineScaleSetListOSUpgradeHistory
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListOSUpgradeHistoryPage) Values() []UpgradeOperationHistoricalStatusInfo
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetListResult the List Virtual Machine operation response.
type VirtualMachineScaleSetListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets.
Value *[]VirtualMachineScaleSet `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslr VirtualMachineScaleSetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListResultIterator provides access to a complete listing of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListResultIterator(page VirtualMachineScaleSetListResultPage) VirtualMachineScaleSetListResultIterator
Creates a new instance of the VirtualMachineScaleSetListResultIterator type.
func (iter *VirtualMachineScaleSetListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineScaleSetListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineScaleSetListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListResultIterator) Response() VirtualMachineScaleSetListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListResultIterator) Value() VirtualMachineScaleSet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListResultPage contains a page of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListResultPage(cur VirtualMachineScaleSetListResult, getNextPage func(context.Context, VirtualMachineScaleSetListResult) (VirtualMachineScaleSetListResult, error)) VirtualMachineScaleSetListResultPage
Creates a new instance of the VirtualMachineScaleSetListResultPage type.
func (page *VirtualMachineScaleSetListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineScaleSetListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineScaleSetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListResultPage) Response() VirtualMachineScaleSetListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListResultPage) Values() []VirtualMachineScaleSet
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetListSkusResult the Virtual Machine Scale Set List Skus operation response.
type VirtualMachineScaleSetListSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the virtual machine scale set.
Value *[]VirtualMachineScaleSetSku `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslsr VirtualMachineScaleSetListSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListSkusResultIterator provides access to a complete listing of VirtualMachineScaleSetSku values.
type VirtualMachineScaleSetListSkusResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListSkusResultIterator(page VirtualMachineScaleSetListSkusResultPage) VirtualMachineScaleSetListSkusResultIterator
Creates a new instance of the VirtualMachineScaleSetListSkusResultIterator type.
func (iter *VirtualMachineScaleSetListSkusResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineScaleSetListSkusResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineScaleSetListSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListSkusResultIterator) Response() VirtualMachineScaleSetListSkusResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListSkusResultIterator) Value() VirtualMachineScaleSetSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListSkusResultPage contains a page of VirtualMachineScaleSetSku values.
type VirtualMachineScaleSetListSkusResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListSkusResultPage(cur VirtualMachineScaleSetListSkusResult, getNextPage func(context.Context, VirtualMachineScaleSetListSkusResult) (VirtualMachineScaleSetListSkusResult, error)) VirtualMachineScaleSetListSkusResultPage
Creates a new instance of the VirtualMachineScaleSetListSkusResultPage type.
func (page *VirtualMachineScaleSetListSkusResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineScaleSetListSkusResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineScaleSetListSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListSkusResultPage) Response() VirtualMachineScaleSetListSkusResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListSkusResultPage) Values() []VirtualMachineScaleSetSku
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetListWithLinkResult the List Virtual Machine operation response.
type VirtualMachineScaleSetListWithLinkResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets.
Value *[]VirtualMachineScaleSet `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.
NextLink *string `json:"nextLink,omitempty"`
}
func (vmsslwlr VirtualMachineScaleSetListWithLinkResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetListWithLinkResultIterator provides access to a complete listing of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListWithLinkResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListWithLinkResultIterator(page VirtualMachineScaleSetListWithLinkResultPage) VirtualMachineScaleSetListWithLinkResultIterator
Creates a new instance of the VirtualMachineScaleSetListWithLinkResultIterator type.
func (iter *VirtualMachineScaleSetListWithLinkResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineScaleSetListWithLinkResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineScaleSetListWithLinkResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetListWithLinkResultIterator) Response() VirtualMachineScaleSetListWithLinkResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetListWithLinkResultIterator) Value() VirtualMachineScaleSet
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetListWithLinkResultPage contains a page of VirtualMachineScaleSet values.
type VirtualMachineScaleSetListWithLinkResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetListWithLinkResultPage(cur VirtualMachineScaleSetListWithLinkResult, getNextPage func(context.Context, VirtualMachineScaleSetListWithLinkResult) (VirtualMachineScaleSetListWithLinkResult, error)) VirtualMachineScaleSetListWithLinkResultPage
Creates a new instance of the VirtualMachineScaleSetListWithLinkResultPage type.
func (page *VirtualMachineScaleSetListWithLinkResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineScaleSetListWithLinkResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineScaleSetListWithLinkResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetListWithLinkResultPage) Response() VirtualMachineScaleSetListWithLinkResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetListWithLinkResultPage) Values() []VirtualMachineScaleSet
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetManagedDiskParameters describes the parameters of a ScaleSet managed disk.
type VirtualMachineScaleSetManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS', 'StorageAccountTypesPremiumZRS', 'StorageAccountTypesStandardSSDZRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// DiskEncryptionSet - Specifies the customer managed disk encryption set resource id for the managed disk.
DiskEncryptionSet *DiskEncryptionSetParameters `json:"diskEncryptionSet,omitempty"`
// SecurityProfile - Specifies the security profile for the managed disk.
SecurityProfile *VMDiskSecurityProfile `json:"securityProfile,omitempty"`
}
VirtualMachineScaleSetNetworkConfiguration describes a virtual machine scale set network profile's network configurations.
type VirtualMachineScaleSetNetworkConfiguration struct {
// Name - The network configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetNetworkConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssnc VirtualMachineScaleSetNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetNetworkConfiguration.
func (vmssnc *VirtualMachineScaleSetNetworkConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetNetworkConfiguration struct.
VirtualMachineScaleSetNetworkConfigurationDNSSettings describes a virtual machines scale sets network configuration's DNS settings.
type VirtualMachineScaleSetNetworkConfigurationDNSSettings struct {
// DNSServers - List of DNS servers IP addresses
DNSServers *[]string `json:"dnsServers,omitempty"`
}
VirtualMachineScaleSetNetworkConfigurationProperties describes a virtual machine scale set network profile's IP configuration.
type VirtualMachineScaleSetNetworkConfigurationProperties struct {
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
// EnableAcceleratedNetworking - Specifies whether the network interface is accelerated networking-enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// EnableFpga - Specifies whether the network interface is FPGA networking-enabled.
EnableFpga *bool `json:"enableFpga,omitempty"`
// NetworkSecurityGroup - The network security group.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
// DNSSettings - The dns settings to be applied on the network interfaces.
DNSSettings *VirtualMachineScaleSetNetworkConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// IPConfigurations - Specifies the IP configurations of the network interface.
IPConfigurations *[]VirtualMachineScaleSetIPConfiguration `json:"ipConfigurations,omitempty"`
// EnableIPForwarding - Whether IP forwarding enabled on this NIC.
EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`
// DeleteOption - Specify what happens to the network interface when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
}
VirtualMachineScaleSetNetworkProfile describes a virtual machine scale set network profile.
type VirtualMachineScaleSetNetworkProfile struct {
// HealthProbe - A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
HealthProbe *APIEntityReference `json:"healthProbe,omitempty"`
// NetworkInterfaceConfigurations - The list of network configurations.
NetworkInterfaceConfigurations *[]VirtualMachineScaleSetNetworkConfiguration `json:"networkInterfaceConfigurations,omitempty"`
// NetworkAPIVersion - specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. Possible values include: 'NetworkAPIVersionTwoZeroTwoZeroHyphenMinusOneOneHyphenMinusZeroOne'
NetworkAPIVersion NetworkAPIVersion `json:"networkApiVersion,omitempty"`
}
VirtualMachineScaleSetOSDisk describes a virtual machine scale set operating system disk.
type VirtualMachineScaleSetOSDisk struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// CreateOption - Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiffDiskSettings - Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
DiffDiskSettings *DiffDiskSettings `json:"diffDiskSettings,omitempty"`
// DiskSizeGB - Specifies the size of the operating system 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"`
// OsType - This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'OperatingSystemTypesWindows', 'OperatingSystemTypesLinux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// Image - Specifies information about the unmanaged user image to base the scale set on.
Image *VirtualHardDisk `json:"image,omitempty"`
// VhdContainers - Specifies the container urls that are used to store operating system disks for the scale set.
VhdContainers *[]string `json:"vhdContainers,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
}
VirtualMachineScaleSetOSProfile describes a virtual machine scale set OS profile.
type VirtualMachineScaleSetOSProfile struct {
// ComputerNamePrefix - Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
ComputerNamePrefix *string `json:"computerNamePrefix,omitempty"`
// AdminUsername - Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in "." <br><br> **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters
AdminUsername *string `json:"adminUsername,omitempty"`
// AdminPassword - Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
AdminPassword *string `json:"adminPassword,omitempty"`
// CustomData - Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)
CustomData *string `json:"customData,omitempty"`
// WindowsConfiguration - Specifies Windows operating system settings on the virtual machine.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// LinuxConfiguration - Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).
LinuxConfiguration *LinuxConfiguration `json:"linuxConfiguration,omitempty"`
// Secrets - Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
// AllowExtensionOperations - Specifies whether extension operations should be allowed on the virtual machine scale set. <br><br>This may only be set to False when no extensions are present on the virtual machine scale set.
AllowExtensionOperations *bool `json:"allowExtensionOperations,omitempty"`
}
VirtualMachineScaleSetProperties describes the properties of a Virtual Machine Scale Set.
type VirtualMachineScaleSetProperties struct {
// UpgradePolicy - The upgrade policy.
UpgradePolicy *UpgradePolicy `json:"upgradePolicy,omitempty"`
// AutomaticRepairsPolicy - Policy for automatic repairs.
AutomaticRepairsPolicy *AutomaticRepairsPolicy `json:"automaticRepairsPolicy,omitempty"`
// VirtualMachineProfile - The virtual machine profile.
VirtualMachineProfile *VirtualMachineScaleSetVMProfile `json:"virtualMachineProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// Overprovision - Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Overprovision *bool `json:"overprovision,omitempty"`
// DoNotRunExtensionsOnOverprovisionedVMs - When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
DoNotRunExtensionsOnOverprovisionedVMs *bool `json:"doNotRunExtensionsOnOverprovisionedVMs,omitempty"`
// UniqueID - READ-ONLY; Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
UniqueID *string `json:"uniqueId,omitempty"`
// SinglePlacementGroup - When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
SinglePlacementGroup *bool `json:"singlePlacementGroup,omitempty"`
// ZoneBalance - Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
ZoneBalance *bool `json:"zoneBalance,omitempty"`
// PlatformFaultDomainCount - Fault Domain count for each placement group.
PlatformFaultDomainCount *int32 `json:"platformFaultDomainCount,omitempty"`
// ProximityPlacementGroup - Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
ProximityPlacementGroup *SubResource `json:"proximityPlacementGroup,omitempty"`
// HostGroup - Specifies information about the dedicated host group that the virtual machine scale set resides in. <br><br>Minimum api-version: 2020-06-01.
HostGroup *SubResource `json:"hostGroup,omitempty"`
// AdditionalCapabilities - Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
AdditionalCapabilities *AdditionalCapabilities `json:"additionalCapabilities,omitempty"`
// ScaleInPolicy - Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
ScaleInPolicy *ScaleInPolicy `json:"scaleInPolicy,omitempty"`
// OrchestrationMode - Specifies the orchestration mode for the virtual machine scale set. Possible values include: 'OrchestrationModeUniform', 'OrchestrationModeFlexible'
OrchestrationMode OrchestrationMode `json:"orchestrationMode,omitempty"`
// SpotRestorePolicy - Specifies the Spot Restore properties for the virtual machine scale set.
SpotRestorePolicy *SpotRestorePolicy `json:"spotRestorePolicy,omitempty"`
// TimeCreated - READ-ONLY; Specifies the time at which the Virtual Machine Scale Set resource was created.<br><br>Minimum api-version: 2021-11-01.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
}
func (vmssp VirtualMachineScaleSetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetProperties.
VirtualMachineScaleSetPublicIPAddressConfiguration describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetPublicIPAddressConfiguration struct {
// Name - The publicIP address configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetPublicIPAddressConfigurationProperties `json:"properties,omitempty"`
Sku *PublicIPAddressSku `json:"sku,omitempty"`
}
func (vmsspiac VirtualMachineScaleSetPublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetPublicIPAddressConfiguration.
func (vmsspiac *VirtualMachineScaleSetPublicIPAddressConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetPublicIPAddressConfiguration struct.
VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings describes a virtual machines scale sets network configuration's DNS settings.
type VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings struct {
// DomainNameLabel - The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created
DomainNameLabel *string `json:"domainNameLabel,omitempty"`
}
VirtualMachineScaleSetPublicIPAddressConfigurationProperties describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetPublicIPAddressConfigurationProperties struct {
// IdleTimeoutInMinutes - The idle timeout of the public IP address.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// DNSSettings - The dns settings to be applied on the publicIP addresses .
DNSSettings *VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// IPTags - The list of IP tags associated with the public IP address.
IPTags *[]VirtualMachineScaleSetIPTag `json:"ipTags,omitempty"`
// PublicIPPrefix - The PublicIPPrefix from which to allocate publicIP addresses.
PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`
// PublicIPAddressVersion - Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPVersionIPv4', 'IPVersionIPv6'
PublicIPAddressVersion IPVersion `json:"publicIPAddressVersion,omitempty"`
// DeleteOption - Specify what happens to the public IP when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
}
VirtualMachineScaleSetReimageParameters describes a Virtual Machine Scale Set VM Reimage Parameters.
type VirtualMachineScaleSetReimageParameters struct {
// InstanceIds - The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
InstanceIds *[]string `json:"instanceIds,omitempty"`
// TempDisk - Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
TempDisk *bool `json:"tempDisk,omitempty"`
}
VirtualMachineScaleSetRollingUpgradesCancelFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetRollingUpgradesCancelFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetRollingUpgradesClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetRollingUpgradesCancelFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetRollingUpgradesClient is the compute Client
type VirtualMachineScaleSetRollingUpgradesClient struct {
BaseClient
}
func NewVirtualMachineScaleSetRollingUpgradesClient(subscriptionID string) VirtualMachineScaleSetRollingUpgradesClient
NewVirtualMachineScaleSetRollingUpgradesClient creates an instance of the VirtualMachineScaleSetRollingUpgradesClient client.
func NewVirtualMachineScaleSetRollingUpgradesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetRollingUpgradesClient
NewVirtualMachineScaleSetRollingUpgradesClientWithBaseURI creates an instance of the VirtualMachineScaleSetRollingUpgradesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineScaleSetRollingUpgradesClient) Cancel(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetRollingUpgradesCancelFuture, err error)
Cancel cancels the current virtual machine scale set rolling upgrade. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) CancelSender(req *http.Request) (future VirtualMachineScaleSetRollingUpgradesCancelFuture, err error)
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatest(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result RollingUpgradeStatusInfo, err error)
GetLatest gets the status of the latest virtual machine scale set rolling upgrade. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetLatestPreparer prepares the GetLatest request.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestResponder(resp *http.Response) (result RollingUpgradeStatusInfo, err error)
GetLatestResponder handles the response to the GetLatest request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) GetLatestSender(req *http.Request) (*http.Response, error)
GetLatestSender sends the GetLatest request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartExtensionUpgrade(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeFuture, err error)
StartExtensionUpgrade starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartExtensionUpgradePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
StartExtensionUpgradePreparer prepares the StartExtensionUpgrade request.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartExtensionUpgradeResponder(resp *http.Response) (result autorest.Response, err error)
StartExtensionUpgradeResponder handles the response to the StartExtensionUpgrade request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartExtensionUpgradeSender(req *http.Request) (future VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeFuture, err error)
StartExtensionUpgradeSender sends the StartExtensionUpgrade request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgrade(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture, err error)
StartOSUpgrade starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
StartOSUpgradePreparer prepares the StartOSUpgrade request.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradeResponder(resp *http.Response) (result autorest.Response, err error)
StartOSUpgradeResponder handles the response to the StartOSUpgrade request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetRollingUpgradesClient) StartOSUpgradeSender(req *http.Request) (future VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture, err error)
StartOSUpgradeSender sends the StartOSUpgrade request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetRollingUpgradesClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetRollingUpgradesStartExtensionUpgradeFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetRollingUpgradesClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetRollingUpgradesStartOSUpgradeFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetScaleInRules enumerates the values for virtual machine scale set scale in rules.
type VirtualMachineScaleSetScaleInRules string
const (
// VirtualMachineScaleSetScaleInRulesDefault ...
VirtualMachineScaleSetScaleInRulesDefault VirtualMachineScaleSetScaleInRules = "Default"
// VirtualMachineScaleSetScaleInRulesNewestVM ...
VirtualMachineScaleSetScaleInRulesNewestVM VirtualMachineScaleSetScaleInRules = "NewestVM"
// VirtualMachineScaleSetScaleInRulesOldestVM ...
VirtualMachineScaleSetScaleInRulesOldestVM VirtualMachineScaleSetScaleInRules = "OldestVM"
)
func PossibleVirtualMachineScaleSetScaleInRulesValues() []VirtualMachineScaleSetScaleInRules
PossibleVirtualMachineScaleSetScaleInRulesValues returns an array of possible values for the VirtualMachineScaleSetScaleInRules const type.
VirtualMachineScaleSetSku describes an available virtual machine scale set sku.
type VirtualMachineScaleSetSku struct {
// ResourceType - READ-ONLY; The type of resource the sku applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Sku - READ-ONLY; The Sku.
Sku *Sku `json:"sku,omitempty"`
// Capacity - READ-ONLY; Specifies the number of virtual machines in the scale set.
Capacity *VirtualMachineScaleSetSkuCapacity `json:"capacity,omitempty"`
}
func (vmsss VirtualMachineScaleSetSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetSku.
VirtualMachineScaleSetSkuCapacity describes scaling information of a sku.
type VirtualMachineScaleSetSkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int64 `json:"maximum,omitempty"`
// DefaultCapacity - READ-ONLY; The default capacity.
DefaultCapacity *int64 `json:"defaultCapacity,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'VirtualMachineScaleSetSkuScaleTypeAutomatic', 'VirtualMachineScaleSetSkuScaleTypeNone'
ScaleType VirtualMachineScaleSetSkuScaleType `json:"scaleType,omitempty"`
}
func (vmsssc VirtualMachineScaleSetSkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetSkuCapacity.
VirtualMachineScaleSetSkuScaleType enumerates the values for virtual machine scale set sku scale type.
type VirtualMachineScaleSetSkuScaleType string
const (
// VirtualMachineScaleSetSkuScaleTypeAutomatic ...
VirtualMachineScaleSetSkuScaleTypeAutomatic VirtualMachineScaleSetSkuScaleType = "Automatic"
// VirtualMachineScaleSetSkuScaleTypeNone ...
VirtualMachineScaleSetSkuScaleTypeNone VirtualMachineScaleSetSkuScaleType = "None"
)
func PossibleVirtualMachineScaleSetSkuScaleTypeValues() []VirtualMachineScaleSetSkuScaleType
PossibleVirtualMachineScaleSetSkuScaleTypeValues returns an array of possible values for the VirtualMachineScaleSetSkuScaleType const type.
VirtualMachineScaleSetStorageProfile describes a virtual machine scale set storage profile.
type VirtualMachineScaleSetStorageProfile struct {
// ImageReference - Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
ImageReference *ImageReference `json:"imageReference,omitempty"`
// OsDisk - Specifies information about the operating system disk used by the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
OsDisk *VirtualMachineScaleSetOSDisk `json:"osDisk,omitempty"`
// DataDisks - Specifies the parameters that are used to add data disks to the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).
DataDisks *[]VirtualMachineScaleSetDataDisk `json:"dataDisks,omitempty"`
}
VirtualMachineScaleSetUpdate describes a Virtual Machine Scale Set.
type VirtualMachineScaleSetUpdate struct {
// Sku - The virtual machine scale set sku.
Sku *Sku `json:"sku,omitempty"`
// Plan - The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineScaleSetUpdateProperties `json:"properties,omitempty"`
// Identity - The identity of the virtual machine scale set, if configured.
Identity *VirtualMachineScaleSetIdentity `json:"identity,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmssu VirtualMachineScaleSetUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdate.
func (vmssu *VirtualMachineScaleSetUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdate struct.
VirtualMachineScaleSetUpdateIPConfiguration describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network
type VirtualMachineScaleSetUpdateIPConfiguration struct {
// Name - The IP configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdateIPConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssuic VirtualMachineScaleSetUpdateIPConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdateIPConfiguration.
func (vmssuic *VirtualMachineScaleSetUpdateIPConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdateIPConfiguration struct.
VirtualMachineScaleSetUpdateIPConfigurationProperties describes a virtual machine scale set network profile's IP configuration properties.
type VirtualMachineScaleSetUpdateIPConfigurationProperties struct {
// Subnet - The subnet.
Subnet *APIEntityReference `json:"subnet,omitempty"`
// Primary - Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
Primary *bool `json:"primary,omitempty"`
// PublicIPAddressConfiguration - The publicIPAddressConfiguration.
PublicIPAddressConfiguration *VirtualMachineScaleSetUpdatePublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
// PrivateIPAddressVersion - Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPVersionIPv4', 'IPVersionIPv6'
PrivateIPAddressVersion IPVersion `json:"privateIPAddressVersion,omitempty"`
// ApplicationGatewayBackendAddressPools - The application gateway backend address pools.
ApplicationGatewayBackendAddressPools *[]SubResource `json:"applicationGatewayBackendAddressPools,omitempty"`
// ApplicationSecurityGroups - Specifies an array of references to application security group.
ApplicationSecurityGroups *[]SubResource `json:"applicationSecurityGroups,omitempty"`
// LoadBalancerBackendAddressPools - The load balancer backend address pools.
LoadBalancerBackendAddressPools *[]SubResource `json:"loadBalancerBackendAddressPools,omitempty"`
// LoadBalancerInboundNatPools - The load balancer inbound nat pools.
LoadBalancerInboundNatPools *[]SubResource `json:"loadBalancerInboundNatPools,omitempty"`
}
VirtualMachineScaleSetUpdateNetworkConfiguration describes a virtual machine scale set network profile's network configurations.
type VirtualMachineScaleSetUpdateNetworkConfiguration struct {
// Name - The network configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdateNetworkConfigurationProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssunc VirtualMachineScaleSetUpdateNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdateNetworkConfiguration.
func (vmssunc *VirtualMachineScaleSetUpdateNetworkConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdateNetworkConfiguration struct.
VirtualMachineScaleSetUpdateNetworkConfigurationProperties describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration.
type VirtualMachineScaleSetUpdateNetworkConfigurationProperties struct {
// Primary - Whether this is a primary NIC on a virtual machine.
Primary *bool `json:"primary,omitempty"`
// EnableAcceleratedNetworking - Specifies whether the network interface is accelerated networking-enabled.
EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`
// EnableFpga - Specifies whether the network interface is FPGA networking-enabled.
EnableFpga *bool `json:"enableFpga,omitempty"`
// NetworkSecurityGroup - The network security group.
NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`
// DNSSettings - The dns settings to be applied on the network interfaces.
DNSSettings *VirtualMachineScaleSetNetworkConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// IPConfigurations - The virtual machine scale set IP Configuration.
IPConfigurations *[]VirtualMachineScaleSetUpdateIPConfiguration `json:"ipConfigurations,omitempty"`
// EnableIPForwarding - Whether IP forwarding enabled on this NIC.
EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`
// DeleteOption - Specify what happens to the network interface when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
}
VirtualMachineScaleSetUpdateNetworkProfile describes a virtual machine scale set network profile.
type VirtualMachineScaleSetUpdateNetworkProfile struct {
// HealthProbe - A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
HealthProbe *APIEntityReference `json:"healthProbe,omitempty"`
// NetworkInterfaceConfigurations - The list of network configurations.
NetworkInterfaceConfigurations *[]VirtualMachineScaleSetUpdateNetworkConfiguration `json:"networkInterfaceConfigurations,omitempty"`
// NetworkAPIVersion - specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'. Possible values include: 'NetworkAPIVersionTwoZeroTwoZeroHyphenMinusOneOneHyphenMinusZeroOne'
NetworkAPIVersion NetworkAPIVersion `json:"networkApiVersion,omitempty"`
}
VirtualMachineScaleSetUpdateOSDisk describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
type VirtualMachineScaleSetUpdateOSDisk struct {
// Caching - The caching type. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// DiskSizeGB - Specifies the size of the operating system 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"`
// Image - The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// VhdContainers - The list of virtual hard disk container uris.
VhdContainers *[]string `json:"vhdContainers,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *VirtualMachineScaleSetManagedDiskParameters `json:"managedDisk,omitempty"`
}
VirtualMachineScaleSetUpdateOSProfile describes a virtual machine scale set OS profile.
type VirtualMachineScaleSetUpdateOSProfile struct {
// CustomData - A base-64 encoded string of custom data.
CustomData *string `json:"customData,omitempty"`
// WindowsConfiguration - The Windows Configuration of the OS profile.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// LinuxConfiguration - The Linux Configuration of the OS profile.
LinuxConfiguration *LinuxConfiguration `json:"linuxConfiguration,omitempty"`
// Secrets - The List of certificates for addition to the VM.
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
}
VirtualMachineScaleSetUpdateProperties describes the properties of a Virtual Machine Scale Set.
type VirtualMachineScaleSetUpdateProperties struct {
// UpgradePolicy - The upgrade policy.
UpgradePolicy *UpgradePolicy `json:"upgradePolicy,omitempty"`
// AutomaticRepairsPolicy - Policy for automatic repairs.
AutomaticRepairsPolicy *AutomaticRepairsPolicy `json:"automaticRepairsPolicy,omitempty"`
// VirtualMachineProfile - The virtual machine profile.
VirtualMachineProfile *VirtualMachineScaleSetUpdateVMProfile `json:"virtualMachineProfile,omitempty"`
// Overprovision - Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Overprovision *bool `json:"overprovision,omitempty"`
// DoNotRunExtensionsOnOverprovisionedVMs - When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
DoNotRunExtensionsOnOverprovisionedVMs *bool `json:"doNotRunExtensionsOnOverprovisionedVMs,omitempty"`
// SinglePlacementGroup - When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
SinglePlacementGroup *bool `json:"singlePlacementGroup,omitempty"`
// AdditionalCapabilities - Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
AdditionalCapabilities *AdditionalCapabilities `json:"additionalCapabilities,omitempty"`
// ScaleInPolicy - Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
ScaleInPolicy *ScaleInPolicy `json:"scaleInPolicy,omitempty"`
// ProximityPlacementGroup - Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
ProximityPlacementGroup *SubResource `json:"proximityPlacementGroup,omitempty"`
}
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetUpdatePublicIPAddressConfiguration struct {
// Name - The publicIP address configuration name.
Name *string `json:"name,omitempty"`
*VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties `json:"properties,omitempty"`
}
func (vmssupiac VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetUpdatePublicIPAddressConfiguration.
func (vmssupiac *VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetUpdatePublicIPAddressConfiguration struct.
VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
type VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties struct {
// IdleTimeoutInMinutes - The idle timeout of the public IP address.
IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`
// DNSSettings - The dns settings to be applied on the publicIP addresses .
DNSSettings *VirtualMachineScaleSetPublicIPAddressConfigurationDNSSettings `json:"dnsSettings,omitempty"`
// PublicIPPrefix - The PublicIPPrefix from which to allocate publicIP addresses.
PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`
// DeleteOption - Specify what happens to the public IP when the VM is deleted. Possible values include: 'DeleteOptionsDelete', 'DeleteOptionsDetach'
DeleteOption DeleteOptions `json:"deleteOption,omitempty"`
}
VirtualMachineScaleSetUpdateStorageProfile describes a virtual machine scale set storage profile.
type VirtualMachineScaleSetUpdateStorageProfile struct {
// ImageReference - The image reference.
ImageReference *ImageReference `json:"imageReference,omitempty"`
// OsDisk - The OS disk.
OsDisk *VirtualMachineScaleSetUpdateOSDisk `json:"osDisk,omitempty"`
// DataDisks - The data disks.
DataDisks *[]VirtualMachineScaleSetDataDisk `json:"dataDisks,omitempty"`
}
VirtualMachineScaleSetUpdateVMProfile describes a virtual machine scale set virtual machine profile.
type VirtualMachineScaleSetUpdateVMProfile struct {
// OsProfile - The virtual machine scale set OS profile.
OsProfile *VirtualMachineScaleSetUpdateOSProfile `json:"osProfile,omitempty"`
// StorageProfile - The virtual machine scale set storage profile.
StorageProfile *VirtualMachineScaleSetUpdateStorageProfile `json:"storageProfile,omitempty"`
// NetworkProfile - The virtual machine scale set network profile.
NetworkProfile *VirtualMachineScaleSetUpdateNetworkProfile `json:"networkProfile,omitempty"`
// SecurityProfile - The virtual machine scale set Security profile
SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
// DiagnosticsProfile - The virtual machine scale set diagnostics profile.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// ExtensionProfile - The virtual machine scale set extension profile.
ExtensionProfile *VirtualMachineScaleSetExtensionProfile `json:"extensionProfile,omitempty"`
// LicenseType - The license type, which is for bring your own license scenario.
LicenseType *string `json:"licenseType,omitempty"`
// BillingProfile - Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01.
BillingProfile *BillingProfile `json:"billingProfile,omitempty"`
// ScheduledEventsProfile - Specifies Scheduled Event related configurations.
ScheduledEventsProfile *ScheduledEventsProfile `json:"scheduledEventsProfile,omitempty"`
// UserData - UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01
UserData *string `json:"userData,omitempty"`
}
VirtualMachineScaleSetVM describes a virtual machine scale set virtual machine.
type VirtualMachineScaleSetVM struct {
autorest.Response `json:"-"`
// InstanceID - READ-ONLY; The virtual machine instance ID.
InstanceID *string `json:"instanceId,omitempty"`
// Sku - READ-ONLY; The virtual machine SKU.
Sku *Sku `json:"sku,omitempty"`
*VirtualMachineScaleSetVMProperties `json:"properties,omitempty"`
// Plan - Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
Plan *Plan `json:"plan,omitempty"`
// Resources - READ-ONLY; The virtual machine child extension resources.
Resources *[]VirtualMachineExtension `json:"resources,omitempty"`
// Zones - READ-ONLY; The virtual machine zones.
Zones *[]string `json:"zones,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Resource name
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
// Location - Resource location
Location *string `json:"location,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmssv VirtualMachineScaleSetVM) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVM.
func (vmssv *VirtualMachineScaleSetVM) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetVM struct.
VirtualMachineScaleSetVMExtension describes a VMSS VM Extension.
type VirtualMachineScaleSetVMExtension struct {
autorest.Response `json:"-"`
// Name - READ-ONLY; The name of the extension.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*VirtualMachineExtensionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssve VirtualMachineScaleSetVMExtension) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMExtension.
func (vmssve *VirtualMachineScaleSetVMExtension) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetVMExtension struct.
VirtualMachineScaleSetVMExtensionUpdate describes a VMSS VM Extension.
type VirtualMachineScaleSetVMExtensionUpdate struct {
// Name - READ-ONLY; The name of the extension.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type
Type *string `json:"type,omitempty"`
*VirtualMachineExtensionUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Resource Id
ID *string `json:"id,omitempty"`
}
func (vmssveu VirtualMachineScaleSetVMExtensionUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMExtensionUpdate.
func (vmssveu *VirtualMachineScaleSetVMExtensionUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineScaleSetVMExtensionUpdate struct.
VirtualMachineScaleSetVMExtensionsClient is the compute Client
type VirtualMachineScaleSetVMExtensionsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetVMExtensionsClient(subscriptionID string) VirtualMachineScaleSetVMExtensionsClient
NewVirtualMachineScaleSetVMExtensionsClient creates an instance of the VirtualMachineScaleSetVMExtensionsClient client.
func NewVirtualMachineScaleSetVMExtensionsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetVMExtensionsClient
NewVirtualMachineScaleSetVMExtensionsClientWithBaseURI creates an instance of the VirtualMachineScaleSetVMExtensionsClient 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 VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, extensionParameters VirtualMachineScaleSetVMExtension) (result VirtualMachineScaleSetVMExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update the VMSS VM extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Create Virtual Machine Extension operation.
func (client VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, extensionParameters VirtualMachineScaleSetVMExtension) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineScaleSetVMExtension, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetVMExtensionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMExtensionsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string) (result VirtualMachineScaleSetVMExtensionsDeleteFuture, err error)
Delete the operation to delete the VMSS VM extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. VMExtensionName - the name of the virtual machine extension.
func (client VirtualMachineScaleSetVMExtensionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetVMExtensionsClient) 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 VirtualMachineScaleSetVMExtensionsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetVMExtensionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMExtensionsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, expand string) (result VirtualMachineScaleSetVMExtension, err error)
Get the operation to get the VMSS VM extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. VMExtensionName - the name of the virtual machine extension. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetVMExtensionsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetVMExtensionsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSetVMExtension, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMExtensionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMExtensionsClient) List(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand string) (result VirtualMachineScaleSetVMExtensionsListResult, err error)
List the operation to get all extensions of an instance in Virtual Machine Scaleset. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetVMExtensionsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetVMExtensionsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetVMExtensionsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMExtensionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMExtensionsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, extensionParameters VirtualMachineScaleSetVMExtensionUpdate) (result VirtualMachineScaleSetVMExtensionsUpdateFuture, err error)
Update the operation to update the VMSS VM extension. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. VMExtensionName - the name of the virtual machine extension. extensionParameters - parameters supplied to the Update Virtual Machine Extension operation.
func (client VirtualMachineScaleSetVMExtensionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMExtensionName string, extensionParameters VirtualMachineScaleSetVMExtensionUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetVMExtensionsClient) UpdateResponder(resp *http.Response) (result VirtualMachineScaleSetVMExtension, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMExtensionsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetVMExtensionsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetVMExtensionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMExtensionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMExtensionsClient) (VirtualMachineScaleSetVMExtension, error)
}
func (future *VirtualMachineScaleSetVMExtensionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMExtensionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMExtensionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMExtensionsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMExtensionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMExtensionsListResult the List VMSS VM Extension operation response
type VirtualMachineScaleSetVMExtensionsListResult struct {
autorest.Response `json:"-"`
// Value - The list of VMSS VM extensions
Value *[]VirtualMachineScaleSetVMExtension `json:"value,omitempty"`
}
VirtualMachineScaleSetVMExtensionsSummary extensions summary for virtual machines of a virtual machine scale set.
type VirtualMachineScaleSetVMExtensionsSummary struct {
// Name - READ-ONLY; The extension name.
Name *string `json:"name,omitempty"`
// StatusesSummary - READ-ONLY; The extensions information.
StatusesSummary *[]VirtualMachineStatusCodeCount `json:"statusesSummary,omitempty"`
}
func (vmssves VirtualMachineScaleSetVMExtensionsSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMExtensionsSummary.
VirtualMachineScaleSetVMExtensionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMExtensionsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMExtensionsClient) (VirtualMachineScaleSetVMExtension, error)
}
func (future *VirtualMachineScaleSetVMExtensionsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMInstanceIDs specifies a list of virtual machine instance IDs from the VM scale set.
type VirtualMachineScaleSetVMInstanceIDs struct {
// InstanceIds - The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
InstanceIds *[]string `json:"instanceIds,omitempty"`
}
VirtualMachineScaleSetVMInstanceRequiredIDs specifies a list of virtual machine instance IDs from the VM scale set.
type VirtualMachineScaleSetVMInstanceRequiredIDs struct {
// InstanceIds - The virtual machine scale set instance ids.
InstanceIds *[]string `json:"instanceIds,omitempty"`
}
VirtualMachineScaleSetVMInstanceView the instance view of a virtual machine scale set VM.
type VirtualMachineScaleSetVMInstanceView struct {
autorest.Response `json:"-"`
// PlatformUpdateDomain - The Update Domain count.
PlatformUpdateDomain *int32 `json:"platformUpdateDomain,omitempty"`
// PlatformFaultDomain - The Fault Domain count.
PlatformFaultDomain *int32 `json:"platformFaultDomain,omitempty"`
// RdpThumbPrint - The Remote desktop certificate thumbprint.
RdpThumbPrint *string `json:"rdpThumbPrint,omitempty"`
// VMAgent - The VM Agent running on the virtual machine.
VMAgent *VirtualMachineAgentInstanceView `json:"vmAgent,omitempty"`
// MaintenanceRedeployStatus - The Maintenance Operation status on the virtual machine.
MaintenanceRedeployStatus *MaintenanceRedeployStatus `json:"maintenanceRedeployStatus,omitempty"`
// Disks - The disks information.
Disks *[]DiskInstanceView `json:"disks,omitempty"`
// Extensions - The extensions information.
Extensions *[]VirtualMachineExtensionInstanceView `json:"extensions,omitempty"`
// VMHealth - READ-ONLY; The health status for the VM.
VMHealth *VirtualMachineHealthStatus `json:"vmHealth,omitempty"`
// BootDiagnostics - Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.
BootDiagnostics *BootDiagnosticsInstanceView `json:"bootDiagnostics,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
// AssignedHost - READ-ONLY; Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. <br><br>Minimum api-version: 2020-06-01.
AssignedHost *string `json:"assignedHost,omitempty"`
// PlacementGroupID - The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
PlacementGroupID *string `json:"placementGroupId,omitempty"`
}
func (vmssviv VirtualMachineScaleSetVMInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMInstanceView.
VirtualMachineScaleSetVMListResult the List Virtual Machine Scale Set VMs operation response.
type VirtualMachineScaleSetVMListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine scale sets VMs.
Value *[]VirtualMachineScaleSetVM `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs
NextLink *string `json:"nextLink,omitempty"`
}
func (vmssvlr VirtualMachineScaleSetVMListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualMachineScaleSetVMListResultIterator provides access to a complete listing of VirtualMachineScaleSetVM values.
type VirtualMachineScaleSetVMListResultIterator struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetVMListResultIterator(page VirtualMachineScaleSetVMListResultPage) VirtualMachineScaleSetVMListResultIterator
Creates a new instance of the VirtualMachineScaleSetVMListResultIterator type.
func (iter *VirtualMachineScaleSetVMListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *VirtualMachineScaleSetVMListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter VirtualMachineScaleSetVMListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualMachineScaleSetVMListResultIterator) Response() VirtualMachineScaleSetVMListResult
Response returns the raw server response from the last page request.
func (iter VirtualMachineScaleSetVMListResultIterator) Value() VirtualMachineScaleSetVM
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualMachineScaleSetVMListResultPage contains a page of VirtualMachineScaleSetVM values.
type VirtualMachineScaleSetVMListResultPage struct {
// contains filtered or unexported fields
}
func NewVirtualMachineScaleSetVMListResultPage(cur VirtualMachineScaleSetVMListResult, getNextPage func(context.Context, VirtualMachineScaleSetVMListResult) (VirtualMachineScaleSetVMListResult, error)) VirtualMachineScaleSetVMListResultPage
Creates a new instance of the VirtualMachineScaleSetVMListResultPage type.
func (page *VirtualMachineScaleSetVMListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *VirtualMachineScaleSetVMListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page VirtualMachineScaleSetVMListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualMachineScaleSetVMListResultPage) Response() VirtualMachineScaleSetVMListResult
Response returns the raw server response from the last page request.
func (page VirtualMachineScaleSetVMListResultPage) Values() []VirtualMachineScaleSetVM
Values returns the slice of values for the current page or nil if there are no values.
VirtualMachineScaleSetVMNetworkProfileConfiguration describes a virtual machine scale set VM network profile.
type VirtualMachineScaleSetVMNetworkProfileConfiguration struct {
// NetworkInterfaceConfigurations - The list of network configurations.
NetworkInterfaceConfigurations *[]VirtualMachineScaleSetNetworkConfiguration `json:"networkInterfaceConfigurations,omitempty"`
}
VirtualMachineScaleSetVMProfile describes a virtual machine scale set virtual machine profile.
type VirtualMachineScaleSetVMProfile struct {
// OsProfile - Specifies the operating system settings for the virtual machines in the scale set.
OsProfile *VirtualMachineScaleSetOSProfile `json:"osProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *VirtualMachineScaleSetStorageProfile `json:"storageProfile,omitempty"`
// NetworkProfile - Specifies properties of the network interfaces of the virtual machines in the scale set.
NetworkProfile *VirtualMachineScaleSetNetworkProfile `json:"networkProfile,omitempty"`
// SecurityProfile - Specifies the Security related profile settings for the virtual machines in the scale set.
SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// ExtensionProfile - Specifies a collection of settings for extensions installed on virtual machines in the scale set.
ExtensionProfile *VirtualMachineScaleSetExtensionProfile `json:"extensionProfile,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
// Priority - Specifies the priority for the virtual machines in the scale set. <br><br>Minimum api-version: 2017-10-30-preview. Possible values include: 'VirtualMachinePriorityTypesRegular', 'VirtualMachinePriorityTypesLow', 'VirtualMachinePriorityTypesSpot'
Priority VirtualMachinePriorityTypes `json:"priority,omitempty"`
// EvictionPolicy - Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. Possible values include: 'VirtualMachineEvictionPolicyTypesDeallocate', 'VirtualMachineEvictionPolicyTypesDelete'
EvictionPolicy VirtualMachineEvictionPolicyTypes `json:"evictionPolicy,omitempty"`
// BillingProfile - Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01.
BillingProfile *BillingProfile `json:"billingProfile,omitempty"`
// ScheduledEventsProfile - Specifies Scheduled Event related configurations.
ScheduledEventsProfile *ScheduledEventsProfile `json:"scheduledEventsProfile,omitempty"`
// UserData - UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01
UserData *string `json:"userData,omitempty"`
// CapacityReservation - Specifies the capacity reservation related details of a scale set. <br><br>Minimum api-version: 2021-04-01.
CapacityReservation *CapacityReservationProfile `json:"capacityReservation,omitempty"`
// ApplicationProfile - Specifies the gallery applications that should be made available to the VM/VMSS
ApplicationProfile *ApplicationProfile `json:"applicationProfile,omitempty"`
// HardwareProfile - Specifies the hardware profile related details of a scale set. <br><br>Minimum api-version: 2021-11-01.
HardwareProfile *VirtualMachineScaleSetHardwareProfile `json:"hardwareProfile,omitempty"`
}
VirtualMachineScaleSetVMProperties describes the properties of a virtual machine scale set virtual machine.
type VirtualMachineScaleSetVMProperties struct {
// LatestModelApplied - READ-ONLY; Specifies whether the latest model has been applied to the virtual machine.
LatestModelApplied *bool `json:"latestModelApplied,omitempty"`
// VMID - READ-ONLY; Azure VM unique ID.
VMID *string `json:"vmId,omitempty"`
// InstanceView - READ-ONLY; The virtual machine instance view.
InstanceView *VirtualMachineScaleSetVMInstanceView `json:"instanceView,omitempty"`
// HardwareProfile - Specifies the hardware settings for the virtual machine.
HardwareProfile *HardwareProfile `json:"hardwareProfile,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *StorageProfile `json:"storageProfile,omitempty"`
// AdditionalCapabilities - Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
AdditionalCapabilities *AdditionalCapabilities `json:"additionalCapabilities,omitempty"`
// OsProfile - Specifies the operating system settings for the virtual machine.
OsProfile *OSProfile `json:"osProfile,omitempty"`
// SecurityProfile - Specifies the Security related profile settings for the virtual machine.
SecurityProfile *SecurityProfile `json:"securityProfile,omitempty"`
// NetworkProfile - Specifies the network interfaces of the virtual machine.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// NetworkProfileConfiguration - Specifies the network profile configuration of the virtual machine.
NetworkProfileConfiguration *VirtualMachineScaleSetVMNetworkProfileConfiguration `json:"networkProfileConfiguration,omitempty"`
// DiagnosticsProfile - Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
// AvailabilitySet - Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
AvailabilitySet *SubResource `json:"availabilitySet,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
ProvisioningState *string `json:"provisioningState,omitempty"`
// LicenseType - Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
LicenseType *string `json:"licenseType,omitempty"`
// ModelDefinitionApplied - READ-ONLY; Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
ModelDefinitionApplied *string `json:"modelDefinitionApplied,omitempty"`
// ProtectionPolicy - Specifies the protection policy of the virtual machine.
ProtectionPolicy *VirtualMachineScaleSetVMProtectionPolicy `json:"protectionPolicy,omitempty"`
// UserData - UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01
UserData *string `json:"userData,omitempty"`
}
func (vmssvp VirtualMachineScaleSetVMProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineScaleSetVMProperties.
VirtualMachineScaleSetVMProtectionPolicy the protection policy of a virtual machine scale set VM.
type VirtualMachineScaleSetVMProtectionPolicy struct {
// ProtectFromScaleIn - Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.
ProtectFromScaleIn *bool `json:"protectFromScaleIn,omitempty"`
// ProtectFromScaleSetActions - Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.
ProtectFromScaleSetActions *bool `json:"protectFromScaleSetActions,omitempty"`
}
VirtualMachineScaleSetVMReimageParameters describes a Virtual Machine Scale Set VM Reimage Parameters.
type VirtualMachineScaleSetVMReimageParameters struct {
// TempDisk - Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
TempDisk *bool `json:"tempDisk,omitempty"`
}
VirtualMachineScaleSetVMRunCommandsClient is the compute Client
type VirtualMachineScaleSetVMRunCommandsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetVMRunCommandsClient(subscriptionID string) VirtualMachineScaleSetVMRunCommandsClient
NewVirtualMachineScaleSetVMRunCommandsClient creates an instance of the VirtualMachineScaleSetVMRunCommandsClient client.
func NewVirtualMachineScaleSetVMRunCommandsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetVMRunCommandsClient
NewVirtualMachineScaleSetVMRunCommandsClientWithBaseURI creates an instance of the VirtualMachineScaleSetVMRunCommandsClient 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 VirtualMachineScaleSetVMRunCommandsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, runCommand VirtualMachineRunCommand) (result VirtualMachineScaleSetVMRunCommandsCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update the VMSS VM run command. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. runCommandName - the name of the virtual machine run command. runCommand - parameters supplied to the Create Virtual Machine RunCommand operation.
func (client VirtualMachineScaleSetVMRunCommandsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, runCommand VirtualMachineRunCommand) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetVMRunCommandsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMRunCommandsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetVMRunCommandsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMRunCommandsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string) (result VirtualMachineScaleSetVMRunCommandsDeleteFuture, err error)
Delete the operation to delete the VMSS VM run command. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. runCommandName - the name of the virtual machine run command.
func (client VirtualMachineScaleSetVMRunCommandsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetVMRunCommandsClient) 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 VirtualMachineScaleSetVMRunCommandsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetVMRunCommandsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMRunCommandsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, expand string) (result VirtualMachineRunCommand, err error)
Get the operation to get the VMSS VM run command. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. runCommandName - the name of the virtual machine run command. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetVMRunCommandsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetVMRunCommandsClient) GetResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMRunCommandsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMRunCommandsClient) List(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand string) (result VirtualMachineRunCommandsListResultPage, err error)
List the operation to get all run commands of an instance in Virtual Machine Scaleset. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. expand - the expand expression to apply on the operation.
func (client VirtualMachineScaleSetVMRunCommandsClient) ListComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand string) (result VirtualMachineRunCommandsListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetVMRunCommandsClient) ListPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetVMRunCommandsClient) ListResponder(resp *http.Response) (result VirtualMachineRunCommandsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMRunCommandsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMRunCommandsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, runCommand VirtualMachineRunCommandUpdate) (result VirtualMachineScaleSetVMRunCommandsUpdateFuture, err error)
Update the operation to update the VMSS VM run command. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. runCommandName - the name of the virtual machine run command. runCommand - parameters supplied to the Update Virtual Machine RunCommand operation.
func (client VirtualMachineScaleSetVMRunCommandsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, runCommandName string, runCommand VirtualMachineRunCommandUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetVMRunCommandsClient) UpdateResponder(resp *http.Response) (result VirtualMachineRunCommand, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMRunCommandsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetVMRunCommandsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetVMRunCommandsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMRunCommandsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMRunCommandsClient) (VirtualMachineRunCommand, error)
}
func (future *VirtualMachineScaleSetVMRunCommandsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMRunCommandsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMRunCommandsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMRunCommandsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMRunCommandsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMRunCommandsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMRunCommandsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMRunCommandsClient) (VirtualMachineRunCommand, error)
}
func (future *VirtualMachineScaleSetVMRunCommandsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsClient is the compute Client
type VirtualMachineScaleSetVMsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetVMsClient(subscriptionID string) VirtualMachineScaleSetVMsClient
NewVirtualMachineScaleSetVMsClient creates an instance of the VirtualMachineScaleSetVMsClient client.
func NewVirtualMachineScaleSetVMsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetVMsClient
NewVirtualMachineScaleSetVMsClientWithBaseURI creates an instance of the VirtualMachineScaleSetVMsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineScaleSetVMsClient) Deallocate(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsDeallocateFuture, err error)
Deallocate deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachineScaleSetVMsClient) DeallocateResponder(resp *http.Response) (result autorest.Response, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) DeallocateSender(req *http.Request) (future VirtualMachineScaleSetVMsDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, forceDeletion *bool) (result VirtualMachineScaleSetVMsDeleteFuture, err error)
Delete deletes a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. forceDeletion - optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview)
func (client VirtualMachineScaleSetVMsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, forceDeletion *bool) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetVMsClient) 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 VirtualMachineScaleSetVMsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetVMsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand InstanceViewTypes) (result VirtualMachineScaleSetVM, err error)
Get gets a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. expand - the expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) GetInstanceView(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMInstanceView, err error)
GetInstanceView gets the status of a virtual machine from a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewResponder(resp *http.Response) (result VirtualMachineScaleSetVMInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand InstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetVMsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSetVM, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) List(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (result VirtualMachineScaleSetVMListResultPage, err error)
List gets a list of all virtual machines in a VM scale sets. Parameters: resourceGroupName - the name of the resource group. virtualMachineScaleSetName - the name of the VM scale set. filter - the filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'. selectParameter - the list parameters. Allowed values are 'instanceView', 'instanceView/statuses'. expand - the expand expression to apply to the operation. Allowed values are 'instanceView'.
func (client VirtualMachineScaleSetVMsClient) ListComplete(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (result VirtualMachineScaleSetVMListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetVMsClient) ListPreparer(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, filter string, selectParameter string, expand string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetVMsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetVMListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) PerformMaintenance(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsPerformMaintenanceFuture, err error)
PerformMaintenance performs maintenance on a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) PerformMaintenancePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
PerformMaintenancePreparer prepares the PerformMaintenance request.
func (client VirtualMachineScaleSetVMsClient) PerformMaintenanceResponder(resp *http.Response) (result autorest.Response, err error)
PerformMaintenanceResponder handles the response to the PerformMaintenance request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) PerformMaintenanceSender(req *http.Request) (future VirtualMachineScaleSetVMsPerformMaintenanceFuture, err error)
PerformMaintenanceSender sends the PerformMaintenance request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) PowerOff(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, skipShutdown *bool) (result VirtualMachineScaleSetVMsPowerOffFuture, err error)
PowerOff power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. skipShutdown - the parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
func (client VirtualMachineScaleSetVMsClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, skipShutdown *bool) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachineScaleSetVMsClient) PowerOffResponder(resp *http.Response) (result autorest.Response, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) PowerOffSender(req *http.Request) (future VirtualMachineScaleSetVMsPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Redeploy(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsRedeployFuture, err error)
Redeploy shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) RedeployPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
RedeployPreparer prepares the Redeploy request.
func (client VirtualMachineScaleSetVMsClient) RedeployResponder(resp *http.Response) (result autorest.Response, err error)
RedeployResponder handles the response to the Redeploy request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) RedeploySender(req *http.Request) (future VirtualMachineScaleSetVMsRedeployFuture, err error)
RedeploySender sends the Redeploy request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Reimage(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMScaleSetVMReimageInput *VirtualMachineScaleSetVMReimageParameters) (result VirtualMachineScaleSetVMsReimageFuture, err error)
Reimage reimages (upgrade the operating system) a specific virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. VMScaleSetVMReimageInput - parameters for the Reimaging Virtual machine in ScaleSet.
func (client VirtualMachineScaleSetVMsClient) ReimageAll(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsReimageAllFuture, err error)
ReimageAll allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) ReimageAllPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
ReimageAllPreparer prepares the ReimageAll request.
func (client VirtualMachineScaleSetVMsClient) ReimageAllResponder(resp *http.Response) (result autorest.Response, err error)
ReimageAllResponder handles the response to the ReimageAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ReimageAllSender(req *http.Request) (future VirtualMachineScaleSetVMsReimageAllFuture, err error)
ReimageAllSender sends the ReimageAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) ReimagePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, VMScaleSetVMReimageInput *VirtualMachineScaleSetVMReimageParameters) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client VirtualMachineScaleSetVMsClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) ReimageSender(req *http.Request) (future VirtualMachineScaleSetVMsReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Restart(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsRestartFuture, err error)
Restart restarts a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachineScaleSetVMsClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) RestartSender(req *http.Request) (future VirtualMachineScaleSetVMsRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) RetrieveBootDiagnosticsData(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, sasURIExpirationTimeInMinutes *int32) (result RetrieveBootDiagnosticsDataResult, err error)
RetrieveBootDiagnosticsData the operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. sasURIExpirationTimeInMinutes - expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. <br><br>NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes.
func (client VirtualMachineScaleSetVMsClient) RetrieveBootDiagnosticsDataPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, sasURIExpirationTimeInMinutes *int32) (*http.Request, error)
RetrieveBootDiagnosticsDataPreparer prepares the RetrieveBootDiagnosticsData request.
func (client VirtualMachineScaleSetVMsClient) RetrieveBootDiagnosticsDataResponder(resp *http.Response) (result RetrieveBootDiagnosticsDataResult, err error)
RetrieveBootDiagnosticsDataResponder handles the response to the RetrieveBootDiagnosticsData request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) RetrieveBootDiagnosticsDataSender(req *http.Request) (*http.Response, error)
RetrieveBootDiagnosticsDataSender sends the RetrieveBootDiagnosticsData request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) RunCommand(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters RunCommandInput) (result VirtualMachineScaleSetVMsRunCommandFuture, err error)
RunCommand run command on a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine. parameters - parameters supplied to the Run command operation.
func (client VirtualMachineScaleSetVMsClient) RunCommandPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters RunCommandInput) (*http.Request, error)
RunCommandPreparer prepares the RunCommand request.
func (client VirtualMachineScaleSetVMsClient) RunCommandResponder(resp *http.Response) (result RunCommandResult, err error)
RunCommandResponder handles the response to the RunCommand request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) RunCommandSender(req *http.Request) (future VirtualMachineScaleSetVMsRunCommandFuture, err error)
RunCommandSender sends the RunCommand request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) SimulateEviction(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result autorest.Response, err error)
SimulateEviction the operation to simulate the eviction of spot virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) SimulateEvictionPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
SimulateEvictionPreparer prepares the SimulateEviction request.
func (client VirtualMachineScaleSetVMsClient) SimulateEvictionResponder(resp *http.Response) (result autorest.Response, err error)
SimulateEvictionResponder handles the response to the SimulateEviction request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) SimulateEvictionSender(req *http.Request) (*http.Response, error)
SimulateEvictionSender sends the SimulateEviction request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Start(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (result VirtualMachineScaleSetVMsStartFuture, err error)
Start starts a virtual machine in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. instanceID - the instance ID of the virtual machine.
func (client VirtualMachineScaleSetVMsClient) StartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachineScaleSetVMsClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) StartSender(req *http.Request) (future VirtualMachineScaleSetVMsStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetVMsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters VirtualMachineScaleSetVM) (result VirtualMachineScaleSetVMsUpdateFuture, err error)
Update updates a virtual machine of a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set where the extension should be create or updated. instanceID - the instance ID of the virtual machine. parameters - parameters supplied to the Update Virtual Machine Scale Sets VM operation.
func (client VirtualMachineScaleSetVMsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters VirtualMachineScaleSetVM) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetVMsClient) UpdateResponder(resp *http.Response) (result VirtualMachineScaleSetVM, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetVMsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetVMsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetVMsDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsPerformMaintenanceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsPerformMaintenanceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsPerformMaintenanceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsRedeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsRedeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsRedeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsReimageAllFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsReimageAllFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsReimageAllFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsRunCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsRunCommandFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (RunCommandResult, error)
}
func (future *VirtualMachineScaleSetVMsRunCommandFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetVMsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetVMsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetVMsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetVMsClient) (VirtualMachineScaleSetVM, error)
}
func (future *VirtualMachineScaleSetVMsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsClient is the compute Client
type VirtualMachineScaleSetsClient struct {
BaseClient
}
func NewVirtualMachineScaleSetsClient(subscriptionID string) VirtualMachineScaleSetsClient
NewVirtualMachineScaleSetsClient creates an instance of the VirtualMachineScaleSetsClient client.
func NewVirtualMachineScaleSetsClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineScaleSetsClient
NewVirtualMachineScaleSetsClientWithBaseURI creates an instance of the VirtualMachineScaleSetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineScaleSetsClient) ConvertToSinglePlacementGroup(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VMScaleSetConvertToSinglePlacementGroupInput) (result autorest.Response, err error)
ConvertToSinglePlacementGroup converts SinglePlacementGroup property to false for a existing virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the virtual machine scale set to create or update. parameters - the input object for ConvertToSinglePlacementGroup API.
func (client VirtualMachineScaleSetsClient) ConvertToSinglePlacementGroupPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VMScaleSetConvertToSinglePlacementGroupInput) (*http.Request, error)
ConvertToSinglePlacementGroupPreparer prepares the ConvertToSinglePlacementGroup request.
func (client VirtualMachineScaleSetsClient) ConvertToSinglePlacementGroupResponder(resp *http.Response) (result autorest.Response, err error)
ConvertToSinglePlacementGroupResponder handles the response to the ConvertToSinglePlacementGroup request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ConvertToSinglePlacementGroupSender(req *http.Request) (*http.Response, error)
ConvertToSinglePlacementGroupSender sends the ConvertToSinglePlacementGroup request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSet) (result VirtualMachineScaleSetsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set to create or update. parameters - the scale set object.
func (client VirtualMachineScaleSetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineScaleSetsClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachineScaleSetsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Deallocate(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsDeallocateFuture, err error)
Deallocate deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachineScaleSetsClient) DeallocateResponder(resp *http.Response) (result autorest.Response, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) DeallocateSender(req *http.Request) (future VirtualMachineScaleSetsDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Delete(ctx context.Context, resourceGroupName string, VMScaleSetName string, forceDeletion *bool) (result VirtualMachineScaleSetsDeleteFuture, err error)
Delete deletes a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. forceDeletion - optional parameter to force delete a VM scale set. (Feature in Preview)
func (client VirtualMachineScaleSetsClient) DeleteInstances(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs, forceDeletion *bool) (result VirtualMachineScaleSetsDeleteInstancesFuture, err error)
DeleteInstances deletes virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set. forceDeletion - optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)
func (client VirtualMachineScaleSetsClient) DeleteInstancesPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs, forceDeletion *bool) (*http.Request, error)
DeleteInstancesPreparer prepares the DeleteInstances request.
func (client VirtualMachineScaleSetsClient) DeleteInstancesResponder(resp *http.Response) (result autorest.Response, err error)
DeleteInstancesResponder handles the response to the DeleteInstances request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) DeleteInstancesSender(req *http.Request) (future VirtualMachineScaleSetsDeleteInstancesFuture, err error)
DeleteInstancesSender sends the DeleteInstances request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, forceDeletion *bool) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineScaleSetsClient) 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 VirtualMachineScaleSetsClient) DeleteSender(req *http.Request) (future VirtualMachineScaleSetsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ForceRecoveryServiceFabricPlatformUpdateDomainWalk(ctx context.Context, resourceGroupName string, VMScaleSetName string, platformUpdateDomain int32, zone string, placementGroupID string) (result RecoveryWalkResponse, err error)
ForceRecoveryServiceFabricPlatformUpdateDomainWalk manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. platformUpdateDomain - the platform update domain for which a manual recovery walk is requested zone - the zone in which the manual recovery walk is requested for cross zone virtual machine scale set placementGroupID - the placement group id for which the manual recovery walk is requested.
func (client VirtualMachineScaleSetsClient) ForceRecoveryServiceFabricPlatformUpdateDomainWalkPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, platformUpdateDomain int32, zone string, placementGroupID string) (*http.Request, error)
ForceRecoveryServiceFabricPlatformUpdateDomainWalkPreparer prepares the ForceRecoveryServiceFabricPlatformUpdateDomainWalk request.
func (client VirtualMachineScaleSetsClient) ForceRecoveryServiceFabricPlatformUpdateDomainWalkResponder(resp *http.Response) (result RecoveryWalkResponse, err error)
ForceRecoveryServiceFabricPlatformUpdateDomainWalkResponder handles the response to the ForceRecoveryServiceFabricPlatformUpdateDomainWalk request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ForceRecoveryServiceFabricPlatformUpdateDomainWalkSender(req *http.Request) (*http.Response, error)
ForceRecoveryServiceFabricPlatformUpdateDomainWalkSender sends the ForceRecoveryServiceFabricPlatformUpdateDomainWalk request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, expand ExpandTypesForGetVMScaleSets) (result VirtualMachineScaleSet, err error)
Get display information about a virtual machine scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. expand - the expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation
func (client VirtualMachineScaleSetsClient) GetInstanceView(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetInstanceView, err error)
GetInstanceView gets the status of a VM scale set instance. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) GetInstanceViewPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetInstanceViewPreparer prepares the GetInstanceView request.
func (client VirtualMachineScaleSetsClient) GetInstanceViewResponder(resp *http.Response) (result VirtualMachineScaleSetInstanceView, err error)
GetInstanceViewResponder handles the response to the GetInstanceView request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) GetInstanceViewSender(req *http.Request) (*http.Response, error)
GetInstanceViewSender sends the GetInstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) GetOSUpgradeHistory(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListOSUpgradeHistoryPage, err error)
GetOSUpgradeHistory gets list of OS upgrades on a VM scale set instance. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) GetOSUpgradeHistoryComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListOSUpgradeHistoryIterator, err error)
GetOSUpgradeHistoryComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) GetOSUpgradeHistoryPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
GetOSUpgradeHistoryPreparer prepares the GetOSUpgradeHistory request.
func (client VirtualMachineScaleSetsClient) GetOSUpgradeHistoryResponder(resp *http.Response) (result VirtualMachineScaleSetListOSUpgradeHistory, err error)
GetOSUpgradeHistoryResponder handles the response to the GetOSUpgradeHistory request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) GetOSUpgradeHistorySender(req *http.Request) (*http.Response, error)
GetOSUpgradeHistorySender sends the GetOSUpgradeHistory request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) GetPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, expand ExpandTypesForGetVMScaleSets) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineScaleSetsClient) GetResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) List(ctx context.Context, resourceGroupName string) (result VirtualMachineScaleSetListResultPage, err error)
List gets a list of all VM scale sets under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client VirtualMachineScaleSetsClient) ListAll(ctx context.Context) (result VirtualMachineScaleSetListWithLinkResultPage, err error)
ListAll gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
func (client VirtualMachineScaleSetsClient) ListAllComplete(ctx context.Context) (result VirtualMachineScaleSetListWithLinkResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListAllPreparer(ctx context.Context) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client VirtualMachineScaleSetsClient) ListAllResponder(resp *http.Response) (result VirtualMachineScaleSetListWithLinkResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ListByLocation(ctx context.Context, location string) (result VirtualMachineScaleSetListResultPage, err error)
ListByLocation gets all the VM scale sets under the specified subscription for the specified location. Parameters: location - the location for which VM scale sets under the subscription are queried.
func (client VirtualMachineScaleSetsClient) ListByLocationComplete(ctx context.Context, location string) (result VirtualMachineScaleSetListResultIterator, err error)
ListByLocationComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListByLocationPreparer(ctx context.Context, location string) (*http.Request, error)
ListByLocationPreparer prepares the ListByLocation request.
func (client VirtualMachineScaleSetsClient) ListByLocationResponder(resp *http.Response) (result VirtualMachineScaleSetListResult, err error)
ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListByLocationSender(req *http.Request) (*http.Response, error)
ListByLocationSender sends the ListByLocation request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result VirtualMachineScaleSetListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineScaleSetsClient) ListResponder(resp *http.Response) (result VirtualMachineScaleSetListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ListSkus(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListSkusResultPage, err error)
ListSkus gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set.
func (client VirtualMachineScaleSetsClient) ListSkusComplete(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result VirtualMachineScaleSetListSkusResultIterator, err error)
ListSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineScaleSetsClient) ListSkusPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (client VirtualMachineScaleSetsClient) ListSkusResponder(resp *http.Response) (result VirtualMachineScaleSetListSkusResult, err error)
ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ListSkusSender(req *http.Request) (*http.Response, error)
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) PerformMaintenance(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsPerformMaintenanceFuture, err error)
PerformMaintenance perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) PerformMaintenancePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
PerformMaintenancePreparer prepares the PerformMaintenance request.
func (client VirtualMachineScaleSetsClient) PerformMaintenanceResponder(resp *http.Response) (result autorest.Response, err error)
PerformMaintenanceResponder handles the response to the PerformMaintenance request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) PerformMaintenanceSender(req *http.Request) (future VirtualMachineScaleSetsPerformMaintenanceFuture, err error)
PerformMaintenanceSender sends the PerformMaintenance request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) PowerOff(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs, skipShutdown *bool) (result VirtualMachineScaleSetsPowerOffFuture, err error)
PowerOff power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set. skipShutdown - the parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
func (client VirtualMachineScaleSetsClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs, skipShutdown *bool) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachineScaleSetsClient) PowerOffResponder(resp *http.Response) (result autorest.Response, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) PowerOffSender(req *http.Request) (future VirtualMachineScaleSetsPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Redeploy(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsRedeployFuture, err error)
Redeploy shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) RedeployPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
RedeployPreparer prepares the Redeploy request.
func (client VirtualMachineScaleSetsClient) RedeployResponder(resp *http.Response) (result autorest.Response, err error)
RedeployResponder handles the response to the Redeploy request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) RedeploySender(req *http.Request) (future VirtualMachineScaleSetsRedeployFuture, err error)
RedeploySender sends the Redeploy request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Reimage(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMScaleSetReimageInput *VirtualMachineScaleSetReimageParameters) (result VirtualMachineScaleSetsReimageFuture, err error)
Reimage reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMScaleSetReimageInput - parameters for Reimaging VM ScaleSet.
func (client VirtualMachineScaleSetsClient) ReimageAll(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsReimageAllFuture, err error)
ReimageAll reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) ReimageAllPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
ReimageAllPreparer prepares the ReimageAll request.
func (client VirtualMachineScaleSetsClient) ReimageAllResponder(resp *http.Response) (result autorest.Response, err error)
ReimageAllResponder handles the response to the ReimageAll request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ReimageAllSender(req *http.Request) (future VirtualMachineScaleSetsReimageAllFuture, err error)
ReimageAllSender sends the ReimageAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) ReimagePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMScaleSetReimageInput *VirtualMachineScaleSetReimageParameters) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client VirtualMachineScaleSetsClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) ReimageSender(req *http.Request) (future VirtualMachineScaleSetsReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Restart(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsRestartFuture, err error)
Restart restarts one or more virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachineScaleSetsClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) RestartSender(req *http.Request) (future VirtualMachineScaleSetsRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) SetOrchestrationServiceState(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters OrchestrationServiceStateInput) (result VirtualMachineScaleSetsSetOrchestrationServiceStateFuture, err error)
SetOrchestrationServiceState changes ServiceState property for a given service Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the virtual machine scale set to create or update. parameters - the input object for SetOrchestrationServiceState API.
func (client VirtualMachineScaleSetsClient) SetOrchestrationServiceStatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters OrchestrationServiceStateInput) (*http.Request, error)
SetOrchestrationServiceStatePreparer prepares the SetOrchestrationServiceState request.
func (client VirtualMachineScaleSetsClient) SetOrchestrationServiceStateResponder(resp *http.Response) (result autorest.Response, err error)
SetOrchestrationServiceStateResponder handles the response to the SetOrchestrationServiceState request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) SetOrchestrationServiceStateSender(req *http.Request) (future VirtualMachineScaleSetsSetOrchestrationServiceStateFuture, err error)
SetOrchestrationServiceStateSender sends the SetOrchestrationServiceState request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Start(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (result VirtualMachineScaleSetsStartFuture, err error)
Start starts one or more virtual machines in a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) StartPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs *VirtualMachineScaleSetVMInstanceIDs) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachineScaleSetsClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) StartSender(req *http.Request) (future VirtualMachineScaleSetsStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSetUpdate) (result VirtualMachineScaleSetsUpdateFuture, err error)
Update update a VM scale set. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set to create or update. parameters - the scale set object.
func (client VirtualMachineScaleSetsClient) UpdateInstances(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (result VirtualMachineScaleSetsUpdateInstancesFuture, err error)
UpdateInstances upgrades one or more virtual machines to the latest SKU set in the VM scale set model. Parameters: resourceGroupName - the name of the resource group. VMScaleSetName - the name of the VM scale set. VMInstanceIDs - a list of virtual machine instance IDs from the VM scale set.
func (client VirtualMachineScaleSetsClient) UpdateInstancesPreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, VMInstanceIDs VirtualMachineScaleSetVMInstanceRequiredIDs) (*http.Request, error)
UpdateInstancesPreparer prepares the UpdateInstances request.
func (client VirtualMachineScaleSetsClient) UpdateInstancesResponder(resp *http.Response) (result autorest.Response, err error)
UpdateInstancesResponder handles the response to the UpdateInstances request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) UpdateInstancesSender(req *http.Request) (future VirtualMachineScaleSetsUpdateInstancesFuture, err error)
UpdateInstancesSender sends the UpdateInstances request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineScaleSetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters VirtualMachineScaleSetUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineScaleSetsClient) UpdateResponder(resp *http.Response) (result VirtualMachineScaleSet, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineScaleSetsClient) UpdateSender(req *http.Request) (future VirtualMachineScaleSetsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineScaleSetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (VirtualMachineScaleSet, error)
}
func (future *VirtualMachineScaleSetsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsDeleteInstancesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsDeleteInstancesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsDeleteInstancesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsPerformMaintenanceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsPerformMaintenanceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsPerformMaintenanceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsRedeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsRedeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsRedeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsReimageAllFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsReimageAllFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsReimageAllFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsSetOrchestrationServiceStateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsSetOrchestrationServiceStateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsSetOrchestrationServiceStateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (VirtualMachineScaleSet, error)
}
func (future *VirtualMachineScaleSetsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineScaleSetsUpdateInstancesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineScaleSetsUpdateInstancesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineScaleSetsClient) (autorest.Response, error)
}
func (future *VirtualMachineScaleSetsUpdateInstancesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineSize describes the properties of a VM size.
type VirtualMachineSize struct {
// Name - The name of the virtual machine size.
Name *string `json:"name,omitempty"`
// NumberOfCores - The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list
NumberOfCores *int32 `json:"numberOfCores,omitempty"`
// OsDiskSizeInMB - The OS disk size, in MB, allowed by the virtual machine size.
OsDiskSizeInMB *int32 `json:"osDiskSizeInMB,omitempty"`
// ResourceDiskSizeInMB - The resource disk size, in MB, allowed by the virtual machine size.
ResourceDiskSizeInMB *int32 `json:"resourceDiskSizeInMB,omitempty"`
// MemoryInMB - The amount of memory, in MB, supported by the virtual machine size.
MemoryInMB *int32 `json:"memoryInMB,omitempty"`
// MaxDataDiskCount - The maximum number of data disks that can be attached to the virtual machine size.
MaxDataDiskCount *int32 `json:"maxDataDiskCount,omitempty"`
}
VirtualMachineSizeListResult the List Virtual Machine operation response.
type VirtualMachineSizeListResult struct {
autorest.Response `json:"-"`
// Value - The list of virtual machine sizes.
Value *[]VirtualMachineSize `json:"value,omitempty"`
}
VirtualMachineSizeTypes enumerates the values for virtual machine size types.
type VirtualMachineSizeTypes string
const (
// VirtualMachineSizeTypesBasicA0 ...
VirtualMachineSizeTypesBasicA0 VirtualMachineSizeTypes = "Basic_A0"
// VirtualMachineSizeTypesBasicA1 ...
VirtualMachineSizeTypesBasicA1 VirtualMachineSizeTypes = "Basic_A1"
// VirtualMachineSizeTypesBasicA2 ...
VirtualMachineSizeTypesBasicA2 VirtualMachineSizeTypes = "Basic_A2"
// VirtualMachineSizeTypesBasicA3 ...
VirtualMachineSizeTypesBasicA3 VirtualMachineSizeTypes = "Basic_A3"
// VirtualMachineSizeTypesBasicA4 ...
VirtualMachineSizeTypesBasicA4 VirtualMachineSizeTypes = "Basic_A4"
// VirtualMachineSizeTypesStandardA0 ...
VirtualMachineSizeTypesStandardA0 VirtualMachineSizeTypes = "Standard_A0"
// VirtualMachineSizeTypesStandardA1 ...
VirtualMachineSizeTypesStandardA1 VirtualMachineSizeTypes = "Standard_A1"
// VirtualMachineSizeTypesStandardA10 ...
VirtualMachineSizeTypesStandardA10 VirtualMachineSizeTypes = "Standard_A10"
// VirtualMachineSizeTypesStandardA11 ...
VirtualMachineSizeTypesStandardA11 VirtualMachineSizeTypes = "Standard_A11"
// VirtualMachineSizeTypesStandardA1V2 ...
VirtualMachineSizeTypesStandardA1V2 VirtualMachineSizeTypes = "Standard_A1_v2"
// VirtualMachineSizeTypesStandardA2 ...
VirtualMachineSizeTypesStandardA2 VirtualMachineSizeTypes = "Standard_A2"
// VirtualMachineSizeTypesStandardA2mV2 ...
VirtualMachineSizeTypesStandardA2mV2 VirtualMachineSizeTypes = "Standard_A2m_v2"
// VirtualMachineSizeTypesStandardA2V2 ...
VirtualMachineSizeTypesStandardA2V2 VirtualMachineSizeTypes = "Standard_A2_v2"
// VirtualMachineSizeTypesStandardA3 ...
VirtualMachineSizeTypesStandardA3 VirtualMachineSizeTypes = "Standard_A3"
// VirtualMachineSizeTypesStandardA4 ...
VirtualMachineSizeTypesStandardA4 VirtualMachineSizeTypes = "Standard_A4"
// VirtualMachineSizeTypesStandardA4mV2 ...
VirtualMachineSizeTypesStandardA4mV2 VirtualMachineSizeTypes = "Standard_A4m_v2"
// VirtualMachineSizeTypesStandardA4V2 ...
VirtualMachineSizeTypesStandardA4V2 VirtualMachineSizeTypes = "Standard_A4_v2"
// VirtualMachineSizeTypesStandardA5 ...
VirtualMachineSizeTypesStandardA5 VirtualMachineSizeTypes = "Standard_A5"
// VirtualMachineSizeTypesStandardA6 ...
VirtualMachineSizeTypesStandardA6 VirtualMachineSizeTypes = "Standard_A6"
// VirtualMachineSizeTypesStandardA7 ...
VirtualMachineSizeTypesStandardA7 VirtualMachineSizeTypes = "Standard_A7"
// VirtualMachineSizeTypesStandardA8 ...
VirtualMachineSizeTypesStandardA8 VirtualMachineSizeTypes = "Standard_A8"
// VirtualMachineSizeTypesStandardA8mV2 ...
VirtualMachineSizeTypesStandardA8mV2 VirtualMachineSizeTypes = "Standard_A8m_v2"
// VirtualMachineSizeTypesStandardA8V2 ...
VirtualMachineSizeTypesStandardA8V2 VirtualMachineSizeTypes = "Standard_A8_v2"
// VirtualMachineSizeTypesStandardA9 ...
VirtualMachineSizeTypesStandardA9 VirtualMachineSizeTypes = "Standard_A9"
// VirtualMachineSizeTypesStandardB1ms ...
VirtualMachineSizeTypesStandardB1ms VirtualMachineSizeTypes = "Standard_B1ms"
// VirtualMachineSizeTypesStandardB1s ...
VirtualMachineSizeTypesStandardB1s VirtualMachineSizeTypes = "Standard_B1s"
// VirtualMachineSizeTypesStandardB2ms ...
VirtualMachineSizeTypesStandardB2ms VirtualMachineSizeTypes = "Standard_B2ms"
// VirtualMachineSizeTypesStandardB2s ...
VirtualMachineSizeTypesStandardB2s VirtualMachineSizeTypes = "Standard_B2s"
// VirtualMachineSizeTypesStandardB4ms ...
VirtualMachineSizeTypesStandardB4ms VirtualMachineSizeTypes = "Standard_B4ms"
// VirtualMachineSizeTypesStandardB8ms ...
VirtualMachineSizeTypesStandardB8ms VirtualMachineSizeTypes = "Standard_B8ms"
// VirtualMachineSizeTypesStandardD1 ...
VirtualMachineSizeTypesStandardD1 VirtualMachineSizeTypes = "Standard_D1"
// VirtualMachineSizeTypesStandardD11 ...
VirtualMachineSizeTypesStandardD11 VirtualMachineSizeTypes = "Standard_D11"
// VirtualMachineSizeTypesStandardD11V2 ...
VirtualMachineSizeTypesStandardD11V2 VirtualMachineSizeTypes = "Standard_D11_v2"
// VirtualMachineSizeTypesStandardD12 ...
VirtualMachineSizeTypesStandardD12 VirtualMachineSizeTypes = "Standard_D12"
// VirtualMachineSizeTypesStandardD12V2 ...
VirtualMachineSizeTypesStandardD12V2 VirtualMachineSizeTypes = "Standard_D12_v2"
// VirtualMachineSizeTypesStandardD13 ...
VirtualMachineSizeTypesStandardD13 VirtualMachineSizeTypes = "Standard_D13"
// VirtualMachineSizeTypesStandardD13V2 ...
VirtualMachineSizeTypesStandardD13V2 VirtualMachineSizeTypes = "Standard_D13_v2"
// VirtualMachineSizeTypesStandardD14 ...
VirtualMachineSizeTypesStandardD14 VirtualMachineSizeTypes = "Standard_D14"
// VirtualMachineSizeTypesStandardD14V2 ...
VirtualMachineSizeTypesStandardD14V2 VirtualMachineSizeTypes = "Standard_D14_v2"
// VirtualMachineSizeTypesStandardD15V2 ...
VirtualMachineSizeTypesStandardD15V2 VirtualMachineSizeTypes = "Standard_D15_v2"
// VirtualMachineSizeTypesStandardD16sV3 ...
VirtualMachineSizeTypesStandardD16sV3 VirtualMachineSizeTypes = "Standard_D16s_v3"
// VirtualMachineSizeTypesStandardD16V3 ...
VirtualMachineSizeTypesStandardD16V3 VirtualMachineSizeTypes = "Standard_D16_v3"
// VirtualMachineSizeTypesStandardD1V2 ...
VirtualMachineSizeTypesStandardD1V2 VirtualMachineSizeTypes = "Standard_D1_v2"
// VirtualMachineSizeTypesStandardD2 ...
VirtualMachineSizeTypesStandardD2 VirtualMachineSizeTypes = "Standard_D2"
// VirtualMachineSizeTypesStandardD2sV3 ...
VirtualMachineSizeTypesStandardD2sV3 VirtualMachineSizeTypes = "Standard_D2s_v3"
// VirtualMachineSizeTypesStandardD2V2 ...
VirtualMachineSizeTypesStandardD2V2 VirtualMachineSizeTypes = "Standard_D2_v2"
// VirtualMachineSizeTypesStandardD2V3 ...
VirtualMachineSizeTypesStandardD2V3 VirtualMachineSizeTypes = "Standard_D2_v3"
// VirtualMachineSizeTypesStandardD3 ...
VirtualMachineSizeTypesStandardD3 VirtualMachineSizeTypes = "Standard_D3"
// VirtualMachineSizeTypesStandardD32sV3 ...
VirtualMachineSizeTypesStandardD32sV3 VirtualMachineSizeTypes = "Standard_D32s_v3"
// VirtualMachineSizeTypesStandardD32V3 ...
VirtualMachineSizeTypesStandardD32V3 VirtualMachineSizeTypes = "Standard_D32_v3"
// VirtualMachineSizeTypesStandardD3V2 ...
VirtualMachineSizeTypesStandardD3V2 VirtualMachineSizeTypes = "Standard_D3_v2"
// VirtualMachineSizeTypesStandardD4 ...
VirtualMachineSizeTypesStandardD4 VirtualMachineSizeTypes = "Standard_D4"
// VirtualMachineSizeTypesStandardD4sV3 ...
VirtualMachineSizeTypesStandardD4sV3 VirtualMachineSizeTypes = "Standard_D4s_v3"
// VirtualMachineSizeTypesStandardD4V2 ...
VirtualMachineSizeTypesStandardD4V2 VirtualMachineSizeTypes = "Standard_D4_v2"
// VirtualMachineSizeTypesStandardD4V3 ...
VirtualMachineSizeTypesStandardD4V3 VirtualMachineSizeTypes = "Standard_D4_v3"
// VirtualMachineSizeTypesStandardD5V2 ...
VirtualMachineSizeTypesStandardD5V2 VirtualMachineSizeTypes = "Standard_D5_v2"
// VirtualMachineSizeTypesStandardD64sV3 ...
VirtualMachineSizeTypesStandardD64sV3 VirtualMachineSizeTypes = "Standard_D64s_v3"
// VirtualMachineSizeTypesStandardD64V3 ...
VirtualMachineSizeTypesStandardD64V3 VirtualMachineSizeTypes = "Standard_D64_v3"
// VirtualMachineSizeTypesStandardD8sV3 ...
VirtualMachineSizeTypesStandardD8sV3 VirtualMachineSizeTypes = "Standard_D8s_v3"
// VirtualMachineSizeTypesStandardD8V3 ...
VirtualMachineSizeTypesStandardD8V3 VirtualMachineSizeTypes = "Standard_D8_v3"
// VirtualMachineSizeTypesStandardDS1 ...
VirtualMachineSizeTypesStandardDS1 VirtualMachineSizeTypes = "Standard_DS1"
// VirtualMachineSizeTypesStandardDS11 ...
VirtualMachineSizeTypesStandardDS11 VirtualMachineSizeTypes = "Standard_DS11"
// VirtualMachineSizeTypesStandardDS11V2 ...
VirtualMachineSizeTypesStandardDS11V2 VirtualMachineSizeTypes = "Standard_DS11_v2"
// VirtualMachineSizeTypesStandardDS12 ...
VirtualMachineSizeTypesStandardDS12 VirtualMachineSizeTypes = "Standard_DS12"
// VirtualMachineSizeTypesStandardDS12V2 ...
VirtualMachineSizeTypesStandardDS12V2 VirtualMachineSizeTypes = "Standard_DS12_v2"
// VirtualMachineSizeTypesStandardDS13 ...
VirtualMachineSizeTypesStandardDS13 VirtualMachineSizeTypes = "Standard_DS13"
// VirtualMachineSizeTypesStandardDS132V2 ...
VirtualMachineSizeTypesStandardDS132V2 VirtualMachineSizeTypes = "Standard_DS13-2_v2"
// VirtualMachineSizeTypesStandardDS134V2 ...
VirtualMachineSizeTypesStandardDS134V2 VirtualMachineSizeTypes = "Standard_DS13-4_v2"
// VirtualMachineSizeTypesStandardDS13V2 ...
VirtualMachineSizeTypesStandardDS13V2 VirtualMachineSizeTypes = "Standard_DS13_v2"
// VirtualMachineSizeTypesStandardDS14 ...
VirtualMachineSizeTypesStandardDS14 VirtualMachineSizeTypes = "Standard_DS14"
// VirtualMachineSizeTypesStandardDS144V2 ...
VirtualMachineSizeTypesStandardDS144V2 VirtualMachineSizeTypes = "Standard_DS14-4_v2"
// VirtualMachineSizeTypesStandardDS148V2 ...
VirtualMachineSizeTypesStandardDS148V2 VirtualMachineSizeTypes = "Standard_DS14-8_v2"
// VirtualMachineSizeTypesStandardDS14V2 ...
VirtualMachineSizeTypesStandardDS14V2 VirtualMachineSizeTypes = "Standard_DS14_v2"
// VirtualMachineSizeTypesStandardDS15V2 ...
VirtualMachineSizeTypesStandardDS15V2 VirtualMachineSizeTypes = "Standard_DS15_v2"
// VirtualMachineSizeTypesStandardDS1V2 ...
VirtualMachineSizeTypesStandardDS1V2 VirtualMachineSizeTypes = "Standard_DS1_v2"
// VirtualMachineSizeTypesStandardDS2 ...
VirtualMachineSizeTypesStandardDS2 VirtualMachineSizeTypes = "Standard_DS2"
// VirtualMachineSizeTypesStandardDS2V2 ...
VirtualMachineSizeTypesStandardDS2V2 VirtualMachineSizeTypes = "Standard_DS2_v2"
// VirtualMachineSizeTypesStandardDS3 ...
VirtualMachineSizeTypesStandardDS3 VirtualMachineSizeTypes = "Standard_DS3"
// VirtualMachineSizeTypesStandardDS3V2 ...
VirtualMachineSizeTypesStandardDS3V2 VirtualMachineSizeTypes = "Standard_DS3_v2"
// VirtualMachineSizeTypesStandardDS4 ...
VirtualMachineSizeTypesStandardDS4 VirtualMachineSizeTypes = "Standard_DS4"
// VirtualMachineSizeTypesStandardDS4V2 ...
VirtualMachineSizeTypesStandardDS4V2 VirtualMachineSizeTypes = "Standard_DS4_v2"
// VirtualMachineSizeTypesStandardDS5V2 ...
VirtualMachineSizeTypesStandardDS5V2 VirtualMachineSizeTypes = "Standard_DS5_v2"
// VirtualMachineSizeTypesStandardE16sV3 ...
VirtualMachineSizeTypesStandardE16sV3 VirtualMachineSizeTypes = "Standard_E16s_v3"
// VirtualMachineSizeTypesStandardE16V3 ...
VirtualMachineSizeTypesStandardE16V3 VirtualMachineSizeTypes = "Standard_E16_v3"
// VirtualMachineSizeTypesStandardE2sV3 ...
VirtualMachineSizeTypesStandardE2sV3 VirtualMachineSizeTypes = "Standard_E2s_v3"
// VirtualMachineSizeTypesStandardE2V3 ...
VirtualMachineSizeTypesStandardE2V3 VirtualMachineSizeTypes = "Standard_E2_v3"
// VirtualMachineSizeTypesStandardE3216V3 ...
VirtualMachineSizeTypesStandardE3216V3 VirtualMachineSizeTypes = "Standard_E32-16_v3"
// VirtualMachineSizeTypesStandardE328sV3 ...
VirtualMachineSizeTypesStandardE328sV3 VirtualMachineSizeTypes = "Standard_E32-8s_v3"
// VirtualMachineSizeTypesStandardE32sV3 ...
VirtualMachineSizeTypesStandardE32sV3 VirtualMachineSizeTypes = "Standard_E32s_v3"
// VirtualMachineSizeTypesStandardE32V3 ...
VirtualMachineSizeTypesStandardE32V3 VirtualMachineSizeTypes = "Standard_E32_v3"
// VirtualMachineSizeTypesStandardE4sV3 ...
VirtualMachineSizeTypesStandardE4sV3 VirtualMachineSizeTypes = "Standard_E4s_v3"
// VirtualMachineSizeTypesStandardE4V3 ...
VirtualMachineSizeTypesStandardE4V3 VirtualMachineSizeTypes = "Standard_E4_v3"
// VirtualMachineSizeTypesStandardE6416sV3 ...
VirtualMachineSizeTypesStandardE6416sV3 VirtualMachineSizeTypes = "Standard_E64-16s_v3"
// VirtualMachineSizeTypesStandardE6432sV3 ...
VirtualMachineSizeTypesStandardE6432sV3 VirtualMachineSizeTypes = "Standard_E64-32s_v3"
// VirtualMachineSizeTypesStandardE64sV3 ...
VirtualMachineSizeTypesStandardE64sV3 VirtualMachineSizeTypes = "Standard_E64s_v3"
// VirtualMachineSizeTypesStandardE64V3 ...
VirtualMachineSizeTypesStandardE64V3 VirtualMachineSizeTypes = "Standard_E64_v3"
// VirtualMachineSizeTypesStandardE8sV3 ...
VirtualMachineSizeTypesStandardE8sV3 VirtualMachineSizeTypes = "Standard_E8s_v3"
// VirtualMachineSizeTypesStandardE8V3 ...
VirtualMachineSizeTypesStandardE8V3 VirtualMachineSizeTypes = "Standard_E8_v3"
// VirtualMachineSizeTypesStandardF1 ...
VirtualMachineSizeTypesStandardF1 VirtualMachineSizeTypes = "Standard_F1"
// VirtualMachineSizeTypesStandardF16 ...
VirtualMachineSizeTypesStandardF16 VirtualMachineSizeTypes = "Standard_F16"
// VirtualMachineSizeTypesStandardF16s ...
VirtualMachineSizeTypesStandardF16s VirtualMachineSizeTypes = "Standard_F16s"
// VirtualMachineSizeTypesStandardF16sV2 ...
VirtualMachineSizeTypesStandardF16sV2 VirtualMachineSizeTypes = "Standard_F16s_v2"
// VirtualMachineSizeTypesStandardF1s ...
VirtualMachineSizeTypesStandardF1s VirtualMachineSizeTypes = "Standard_F1s"
// VirtualMachineSizeTypesStandardF2 ...
VirtualMachineSizeTypesStandardF2 VirtualMachineSizeTypes = "Standard_F2"
// VirtualMachineSizeTypesStandardF2s ...
VirtualMachineSizeTypesStandardF2s VirtualMachineSizeTypes = "Standard_F2s"
// VirtualMachineSizeTypesStandardF2sV2 ...
VirtualMachineSizeTypesStandardF2sV2 VirtualMachineSizeTypes = "Standard_F2s_v2"
// VirtualMachineSizeTypesStandardF32sV2 ...
VirtualMachineSizeTypesStandardF32sV2 VirtualMachineSizeTypes = "Standard_F32s_v2"
// VirtualMachineSizeTypesStandardF4 ...
VirtualMachineSizeTypesStandardF4 VirtualMachineSizeTypes = "Standard_F4"
// VirtualMachineSizeTypesStandardF4s ...
VirtualMachineSizeTypesStandardF4s VirtualMachineSizeTypes = "Standard_F4s"
// VirtualMachineSizeTypesStandardF4sV2 ...
VirtualMachineSizeTypesStandardF4sV2 VirtualMachineSizeTypes = "Standard_F4s_v2"
// VirtualMachineSizeTypesStandardF64sV2 ...
VirtualMachineSizeTypesStandardF64sV2 VirtualMachineSizeTypes = "Standard_F64s_v2"
// VirtualMachineSizeTypesStandardF72sV2 ...
VirtualMachineSizeTypesStandardF72sV2 VirtualMachineSizeTypes = "Standard_F72s_v2"
// VirtualMachineSizeTypesStandardF8 ...
VirtualMachineSizeTypesStandardF8 VirtualMachineSizeTypes = "Standard_F8"
// VirtualMachineSizeTypesStandardF8s ...
VirtualMachineSizeTypesStandardF8s VirtualMachineSizeTypes = "Standard_F8s"
// VirtualMachineSizeTypesStandardF8sV2 ...
VirtualMachineSizeTypesStandardF8sV2 VirtualMachineSizeTypes = "Standard_F8s_v2"
// VirtualMachineSizeTypesStandardG1 ...
VirtualMachineSizeTypesStandardG1 VirtualMachineSizeTypes = "Standard_G1"
// VirtualMachineSizeTypesStandardG2 ...
VirtualMachineSizeTypesStandardG2 VirtualMachineSizeTypes = "Standard_G2"
// VirtualMachineSizeTypesStandardG3 ...
VirtualMachineSizeTypesStandardG3 VirtualMachineSizeTypes = "Standard_G3"
// VirtualMachineSizeTypesStandardG4 ...
VirtualMachineSizeTypesStandardG4 VirtualMachineSizeTypes = "Standard_G4"
// VirtualMachineSizeTypesStandardG5 ...
VirtualMachineSizeTypesStandardG5 VirtualMachineSizeTypes = "Standard_G5"
// VirtualMachineSizeTypesStandardGS1 ...
VirtualMachineSizeTypesStandardGS1 VirtualMachineSizeTypes = "Standard_GS1"
// VirtualMachineSizeTypesStandardGS2 ...
VirtualMachineSizeTypesStandardGS2 VirtualMachineSizeTypes = "Standard_GS2"
// VirtualMachineSizeTypesStandardGS3 ...
VirtualMachineSizeTypesStandardGS3 VirtualMachineSizeTypes = "Standard_GS3"
// VirtualMachineSizeTypesStandardGS4 ...
VirtualMachineSizeTypesStandardGS4 VirtualMachineSizeTypes = "Standard_GS4"
// VirtualMachineSizeTypesStandardGS44 ...
VirtualMachineSizeTypesStandardGS44 VirtualMachineSizeTypes = "Standard_GS4-4"
// VirtualMachineSizeTypesStandardGS48 ...
VirtualMachineSizeTypesStandardGS48 VirtualMachineSizeTypes = "Standard_GS4-8"
// VirtualMachineSizeTypesStandardGS5 ...
VirtualMachineSizeTypesStandardGS5 VirtualMachineSizeTypes = "Standard_GS5"
// VirtualMachineSizeTypesStandardGS516 ...
VirtualMachineSizeTypesStandardGS516 VirtualMachineSizeTypes = "Standard_GS5-16"
// VirtualMachineSizeTypesStandardGS58 ...
VirtualMachineSizeTypesStandardGS58 VirtualMachineSizeTypes = "Standard_GS5-8"
// VirtualMachineSizeTypesStandardH16 ...
VirtualMachineSizeTypesStandardH16 VirtualMachineSizeTypes = "Standard_H16"
// VirtualMachineSizeTypesStandardH16m ...
VirtualMachineSizeTypesStandardH16m VirtualMachineSizeTypes = "Standard_H16m"
// VirtualMachineSizeTypesStandardH16mr ...
VirtualMachineSizeTypesStandardH16mr VirtualMachineSizeTypes = "Standard_H16mr"
// VirtualMachineSizeTypesStandardH16r ...
VirtualMachineSizeTypesStandardH16r VirtualMachineSizeTypes = "Standard_H16r"
// VirtualMachineSizeTypesStandardH8 ...
VirtualMachineSizeTypesStandardH8 VirtualMachineSizeTypes = "Standard_H8"
// VirtualMachineSizeTypesStandardH8m ...
VirtualMachineSizeTypesStandardH8m VirtualMachineSizeTypes = "Standard_H8m"
// VirtualMachineSizeTypesStandardL16s ...
VirtualMachineSizeTypesStandardL16s VirtualMachineSizeTypes = "Standard_L16s"
// VirtualMachineSizeTypesStandardL32s ...
VirtualMachineSizeTypesStandardL32s VirtualMachineSizeTypes = "Standard_L32s"
// VirtualMachineSizeTypesStandardL4s ...
VirtualMachineSizeTypesStandardL4s VirtualMachineSizeTypes = "Standard_L4s"
// VirtualMachineSizeTypesStandardL8s ...
VirtualMachineSizeTypesStandardL8s VirtualMachineSizeTypes = "Standard_L8s"
// VirtualMachineSizeTypesStandardM12832ms ...
VirtualMachineSizeTypesStandardM12832ms VirtualMachineSizeTypes = "Standard_M128-32ms"
// VirtualMachineSizeTypesStandardM12864ms ...
VirtualMachineSizeTypesStandardM12864ms VirtualMachineSizeTypes = "Standard_M128-64ms"
// VirtualMachineSizeTypesStandardM128ms ...
VirtualMachineSizeTypesStandardM128ms VirtualMachineSizeTypes = "Standard_M128ms"
// VirtualMachineSizeTypesStandardM128s ...
VirtualMachineSizeTypesStandardM128s VirtualMachineSizeTypes = "Standard_M128s"
// VirtualMachineSizeTypesStandardM6416ms ...
VirtualMachineSizeTypesStandardM6416ms VirtualMachineSizeTypes = "Standard_M64-16ms"
// VirtualMachineSizeTypesStandardM6432ms ...
VirtualMachineSizeTypesStandardM6432ms VirtualMachineSizeTypes = "Standard_M64-32ms"
// VirtualMachineSizeTypesStandardM64ms ...
VirtualMachineSizeTypesStandardM64ms VirtualMachineSizeTypes = "Standard_M64ms"
// VirtualMachineSizeTypesStandardM64s ...
VirtualMachineSizeTypesStandardM64s VirtualMachineSizeTypes = "Standard_M64s"
// VirtualMachineSizeTypesStandardNC12 ...
VirtualMachineSizeTypesStandardNC12 VirtualMachineSizeTypes = "Standard_NC12"
// VirtualMachineSizeTypesStandardNC12sV2 ...
VirtualMachineSizeTypesStandardNC12sV2 VirtualMachineSizeTypes = "Standard_NC12s_v2"
// VirtualMachineSizeTypesStandardNC12sV3 ...
VirtualMachineSizeTypesStandardNC12sV3 VirtualMachineSizeTypes = "Standard_NC12s_v3"
// VirtualMachineSizeTypesStandardNC24 ...
VirtualMachineSizeTypesStandardNC24 VirtualMachineSizeTypes = "Standard_NC24"
// VirtualMachineSizeTypesStandardNC24r ...
VirtualMachineSizeTypesStandardNC24r VirtualMachineSizeTypes = "Standard_NC24r"
// VirtualMachineSizeTypesStandardNC24rsV2 ...
VirtualMachineSizeTypesStandardNC24rsV2 VirtualMachineSizeTypes = "Standard_NC24rs_v2"
// VirtualMachineSizeTypesStandardNC24rsV3 ...
VirtualMachineSizeTypesStandardNC24rsV3 VirtualMachineSizeTypes = "Standard_NC24rs_v3"
// VirtualMachineSizeTypesStandardNC24sV2 ...
VirtualMachineSizeTypesStandardNC24sV2 VirtualMachineSizeTypes = "Standard_NC24s_v2"
// VirtualMachineSizeTypesStandardNC24sV3 ...
VirtualMachineSizeTypesStandardNC24sV3 VirtualMachineSizeTypes = "Standard_NC24s_v3"
// VirtualMachineSizeTypesStandardNC6 ...
VirtualMachineSizeTypesStandardNC6 VirtualMachineSizeTypes = "Standard_NC6"
// VirtualMachineSizeTypesStandardNC6sV2 ...
VirtualMachineSizeTypesStandardNC6sV2 VirtualMachineSizeTypes = "Standard_NC6s_v2"
// VirtualMachineSizeTypesStandardNC6sV3 ...
VirtualMachineSizeTypesStandardNC6sV3 VirtualMachineSizeTypes = "Standard_NC6s_v3"
// VirtualMachineSizeTypesStandardND12s ...
VirtualMachineSizeTypesStandardND12s VirtualMachineSizeTypes = "Standard_ND12s"
// VirtualMachineSizeTypesStandardND24rs ...
VirtualMachineSizeTypesStandardND24rs VirtualMachineSizeTypes = "Standard_ND24rs"
// VirtualMachineSizeTypesStandardND24s ...
VirtualMachineSizeTypesStandardND24s VirtualMachineSizeTypes = "Standard_ND24s"
// VirtualMachineSizeTypesStandardND6s ...
VirtualMachineSizeTypesStandardND6s VirtualMachineSizeTypes = "Standard_ND6s"
// VirtualMachineSizeTypesStandardNV12 ...
VirtualMachineSizeTypesStandardNV12 VirtualMachineSizeTypes = "Standard_NV12"
// VirtualMachineSizeTypesStandardNV24 ...
VirtualMachineSizeTypesStandardNV24 VirtualMachineSizeTypes = "Standard_NV24"
// VirtualMachineSizeTypesStandardNV6 ...
VirtualMachineSizeTypesStandardNV6 VirtualMachineSizeTypes = "Standard_NV6"
)
func PossibleVirtualMachineSizeTypesValues() []VirtualMachineSizeTypes
PossibleVirtualMachineSizeTypesValues returns an array of possible values for the VirtualMachineSizeTypes const type.
VirtualMachineSizesClient is the compute Client
type VirtualMachineSizesClient struct {
BaseClient
}
func NewVirtualMachineSizesClient(subscriptionID string) VirtualMachineSizesClient
NewVirtualMachineSizesClient creates an instance of the VirtualMachineSizesClient client.
func NewVirtualMachineSizesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineSizesClient
NewVirtualMachineSizesClientWithBaseURI creates an instance of the VirtualMachineSizesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachineSizesClient) List(ctx context.Context, location string) (result VirtualMachineSizeListResult, err error)
List this API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list) Parameters: location - the location upon which virtual-machine-sizes is queried.
func (client VirtualMachineSizesClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineSizesClient) ListResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineSizesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
VirtualMachineSoftwarePatchProperties describes the properties of a Virtual Machine software patch.
type VirtualMachineSoftwarePatchProperties struct {
// PatchID - READ-ONLY; A unique identifier for the patch.
PatchID *string `json:"patchId,omitempty"`
// Name - READ-ONLY; The friendly name of the patch.
Name *string `json:"name,omitempty"`
// Version - READ-ONLY; The version number of the patch. This property applies only to Linux patches.
Version *string `json:"version,omitempty"`
// KbID - READ-ONLY; The KBID of the patch. Only applies to Windows patches.
KbID *string `json:"kbId,omitempty"`
// Classifications - READ-ONLY; The classification(s) of the patch as provided by the patch publisher.
Classifications *[]string `json:"classifications,omitempty"`
// RebootBehavior - READ-ONLY; Describes the reboot requirements of the patch. Possible values include: 'VMGuestPatchRebootBehaviorUnknown', 'VMGuestPatchRebootBehaviorNeverReboots', 'VMGuestPatchRebootBehaviorAlwaysRequiresReboot', 'VMGuestPatchRebootBehaviorCanRequestReboot'
RebootBehavior VMGuestPatchRebootBehavior `json:"rebootBehavior,omitempty"`
// ActivityID - READ-ONLY; The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
ActivityID *string `json:"activityId,omitempty"`
// PublishedDate - READ-ONLY; The UTC timestamp when the repository published this patch.
PublishedDate *date.Time `json:"publishedDate,omitempty"`
// LastModifiedDateTime - READ-ONLY; The UTC timestamp of the last update to this patch record.
LastModifiedDateTime *date.Time `json:"lastModifiedDateTime,omitempty"`
// AssessmentState - READ-ONLY; Describes the availability of a given patch. Possible values include: 'PatchAssessmentStateUnknown', 'PatchAssessmentStateAvailable'
AssessmentState PatchAssessmentState `json:"assessmentState,omitempty"`
}
func (vmspp VirtualMachineSoftwarePatchProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineSoftwarePatchProperties.
VirtualMachineStatusCodeCount the status code and count of the virtual machine scale set instance view status summary.
type VirtualMachineStatusCodeCount struct {
// Code - READ-ONLY; The instance view status code.
Code *string `json:"code,omitempty"`
// Count - READ-ONLY; The number of instances having a particular status code.
Count *int32 `json:"count,omitempty"`
}
func (vmscc VirtualMachineStatusCodeCount) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineStatusCodeCount.
VirtualMachineUpdate describes a Virtual Machine Update.
type VirtualMachineUpdate struct {
// Plan - Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
Plan *Plan `json:"plan,omitempty"`
*VirtualMachineProperties `json:"properties,omitempty"`
// Identity - The identity of the virtual machine, if configured.
Identity *VirtualMachineIdentity `json:"identity,omitempty"`
// Zones - The virtual machine zones.
Zones *[]string `json:"zones,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (vmu VirtualMachineUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineUpdate.
func (vmu *VirtualMachineUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualMachineUpdate struct.
VirtualMachinesAssessPatchesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesAssessPatchesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachineAssessPatchesResult, error)
}
func (future *VirtualMachinesAssessPatchesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesCaptureFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesCaptureFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachineCaptureResult, error)
}
func (future *VirtualMachinesCaptureFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesClient is the compute Client
type VirtualMachinesClient struct {
BaseClient
}
func NewVirtualMachinesClient(subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClient creates an instance of the VirtualMachinesClient client.
func NewVirtualMachinesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClientWithBaseURI creates an instance of the VirtualMachinesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client VirtualMachinesClient) AssessPatches(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesAssessPatchesFuture, err error)
AssessPatches assess patches on the VM. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) AssessPatchesPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
AssessPatchesPreparer prepares the AssessPatches request.
func (client VirtualMachinesClient) AssessPatchesResponder(resp *http.Response) (result VirtualMachineAssessPatchesResult, err error)
AssessPatchesResponder handles the response to the AssessPatches request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) AssessPatchesSender(req *http.Request) (future VirtualMachinesAssessPatchesFuture, err error)
AssessPatchesSender sends the AssessPatches request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Capture(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineCaptureParameters) (result VirtualMachinesCaptureFuture, err error)
Capture captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Capture Virtual Machine operation.
func (client VirtualMachinesClient) CapturePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineCaptureParameters) (*http.Request, error)
CapturePreparer prepares the Capture request.
func (client VirtualMachinesClient) CaptureResponder(resp *http.Response) (result VirtualMachineCaptureResult, err error)
CaptureResponder handles the response to the Capture request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) CaptureSender(req *http.Request) (future VirtualMachinesCaptureFuture, err error)
CaptureSender sends the Capture request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ConvertToManagedDisks(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesConvertToManagedDisksFuture, err error)
ConvertToManagedDisks converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) ConvertToManagedDisksPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
ConvertToManagedDisksPreparer prepares the ConvertToManagedDisks request.
func (client VirtualMachinesClient) ConvertToManagedDisksResponder(resp *http.Response) (result autorest.Response, err error)
ConvertToManagedDisksResponder handles the response to the ConvertToManagedDisks request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ConvertToManagedDisksSender(req *http.Request) (future VirtualMachinesConvertToManagedDisksFuture, err error)
ConvertToManagedDisksSender sends the ConvertToManagedDisks request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachine) (result VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Create Virtual Machine operation.
func (client VirtualMachinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachine) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachinesClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualMachine, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Deallocate(ctx context.Context, resourceGroupName string, VMName string, hibernate *bool) (result VirtualMachinesDeallocateFuture, err error)
Deallocate shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. hibernate - optional parameter to hibernate a virtual machine. (Feature in Preview)
func (client VirtualMachinesClient) DeallocatePreparer(ctx context.Context, resourceGroupName string, VMName string, hibernate *bool) (*http.Request, error)
DeallocatePreparer prepares the Deallocate request.
func (client VirtualMachinesClient) DeallocateResponder(resp *http.Response) (result autorest.Response, err error)
DeallocateResponder handles the response to the Deallocate request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) DeallocateSender(req *http.Request) (future VirtualMachinesDeallocateFuture, err error)
DeallocateSender sends the Deallocate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Delete(ctx context.Context, resourceGroupName string, VMName string, forceDeletion *bool) (result VirtualMachinesDeleteFuture, err error)
Delete the operation to delete a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. forceDeletion - optional parameter to force delete virtual machines.
func (client VirtualMachinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, VMName string, forceDeletion *bool) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachinesClient) 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 VirtualMachinesClient) DeleteSender(req *http.Request) (future VirtualMachinesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Generalize(ctx context.Context, resourceGroupName string, VMName string) (result autorest.Response, err error)
Generalize sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. <br>For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource).<br>For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image). Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) GeneralizePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
GeneralizePreparer prepares the Generalize request.
func (client VirtualMachinesClient) GeneralizeResponder(resp *http.Response) (result autorest.Response, err error)
GeneralizeResponder handles the response to the Generalize request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GeneralizeSender(req *http.Request) (*http.Response, error)
GeneralizeSender sends the Generalize request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Get(ctx context.Context, resourceGroupName string, VMName string, expand InstanceViewTypes) (result VirtualMachine, err error)
Get retrieves information about the model view or the instance view of a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. expand - the expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.
func (client VirtualMachinesClient) GetPreparer(ctx context.Context, resourceGroupName string, VMName string, expand InstanceViewTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachinesClient) GetResponder(resp *http.Response) (result VirtualMachine, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) InstallPatches(ctx context.Context, resourceGroupName string, VMName string, installPatchesInput VirtualMachineInstallPatchesParameters) (result VirtualMachinesInstallPatchesFuture, err error)
InstallPatches installs patches on the VM. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. installPatchesInput - input for InstallPatches as directly received by the API
func (client VirtualMachinesClient) InstallPatchesPreparer(ctx context.Context, resourceGroupName string, VMName string, installPatchesInput VirtualMachineInstallPatchesParameters) (*http.Request, error)
InstallPatchesPreparer prepares the InstallPatches request.
func (client VirtualMachinesClient) InstallPatchesResponder(resp *http.Response) (result VirtualMachineInstallPatchesResult, err error)
InstallPatchesResponder handles the response to the InstallPatches request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) InstallPatchesSender(req *http.Request) (future VirtualMachinesInstallPatchesFuture, err error)
InstallPatchesSender sends the InstallPatches request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) InstanceView(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachineInstanceView, err error)
InstanceView retrieves information about the run-time state of a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) InstanceViewPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
InstanceViewPreparer prepares the InstanceView request.
func (client VirtualMachinesClient) InstanceViewResponder(resp *http.Response) (result VirtualMachineInstanceView, err error)
InstanceViewResponder handles the response to the InstanceView request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) InstanceViewSender(req *http.Request) (*http.Response, error)
InstanceViewSender sends the InstanceView request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) List(ctx context.Context, resourceGroupName string, filter string) (result VirtualMachineListResultPage, err error)
List lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines. Parameters: resourceGroupName - the name of the resource group. filter - the system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'
func (client VirtualMachinesClient) ListAll(ctx context.Context, statusOnly string, filter string) (result VirtualMachineListResultPage, err error)
ListAll lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines. Parameters: statusOnly - statusOnly=true enables fetching run time status of all Virtual Machines in the subscription. filter - the system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'
func (client VirtualMachinesClient) ListAllComplete(ctx context.Context, statusOnly string, filter string) (result VirtualMachineListResultIterator, err error)
ListAllComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListAllPreparer(ctx context.Context, statusOnly string, filter string) (*http.Request, error)
ListAllPreparer prepares the ListAll request.
func (client VirtualMachinesClient) ListAllResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListAllSender(req *http.Request) (*http.Response, error)
ListAllSender sends the ListAll request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListAvailableSizes(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachineSizeListResult, err error)
ListAvailableSizes lists all available virtual machine sizes to which the specified virtual machine can be resized. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
ListAvailableSizesPreparer prepares the ListAvailableSizes request.
func (client VirtualMachinesClient) ListAvailableSizesResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)
ListAvailableSizesResponder handles the response to the ListAvailableSizes request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListAvailableSizesSender(req *http.Request) (*http.Response, error)
ListAvailableSizesSender sends the ListAvailableSizes request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListByLocation(ctx context.Context, location string) (result VirtualMachineListResultPage, err error)
ListByLocation gets all the virtual machines under the specified subscription for the specified location. Parameters: location - the location for which virtual machines under the subscription are queried.
func (client VirtualMachinesClient) ListByLocationComplete(ctx context.Context, location string) (result VirtualMachineListResultIterator, err error)
ListByLocationComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListByLocationPreparer(ctx context.Context, location string) (*http.Request, error)
ListByLocationPreparer prepares the ListByLocation request.
func (client VirtualMachinesClient) ListByLocationResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListByLocationSender(req *http.Request) (*http.Response, error)
ListByLocationSender sends the ListByLocation request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListComplete(ctx context.Context, resourceGroupName string, filter string) (result VirtualMachineListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) ListPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachinesClient) ListResponder(resp *http.Response) (result VirtualMachineListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) PerformMaintenance(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesPerformMaintenanceFuture, err error)
PerformMaintenance the operation to perform maintenance on a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) PerformMaintenancePreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
PerformMaintenancePreparer prepares the PerformMaintenance request.
func (client VirtualMachinesClient) PerformMaintenanceResponder(resp *http.Response) (result autorest.Response, err error)
PerformMaintenanceResponder handles the response to the PerformMaintenance request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) PerformMaintenanceSender(req *http.Request) (future VirtualMachinesPerformMaintenanceFuture, err error)
PerformMaintenanceSender sends the PerformMaintenance request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) PowerOff(ctx context.Context, resourceGroupName string, VMName string, skipShutdown *bool) (result VirtualMachinesPowerOffFuture, err error)
PowerOff the operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. skipShutdown - the parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
func (client VirtualMachinesClient) PowerOffPreparer(ctx context.Context, resourceGroupName string, VMName string, skipShutdown *bool) (*http.Request, error)
PowerOffPreparer prepares the PowerOff request.
func (client VirtualMachinesClient) PowerOffResponder(resp *http.Response) (result autorest.Response, err error)
PowerOffResponder handles the response to the PowerOff request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) PowerOffSender(req *http.Request) (future VirtualMachinesPowerOffFuture, err error)
PowerOffSender sends the PowerOff request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Reapply(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesReapplyFuture, err error)
Reapply the operation to reapply a virtual machine's state. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) ReapplyPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
ReapplyPreparer prepares the Reapply request.
func (client VirtualMachinesClient) ReapplyResponder(resp *http.Response) (result autorest.Response, err error)
ReapplyResponder handles the response to the Reapply request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ReapplySender(req *http.Request) (future VirtualMachinesReapplyFuture, err error)
ReapplySender sends the Reapply request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Redeploy(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesRedeployFuture, err error)
Redeploy shuts down the virtual machine, moves it to a new node, and powers it back on. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) RedeployPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
RedeployPreparer prepares the Redeploy request.
func (client VirtualMachinesClient) RedeployResponder(resp *http.Response) (result autorest.Response, err error)
RedeployResponder handles the response to the Redeploy request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RedeploySender(req *http.Request) (future VirtualMachinesRedeployFuture, err error)
RedeploySender sends the Redeploy request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Reimage(ctx context.Context, resourceGroupName string, VMName string, parameters *VirtualMachineReimageParameters) (result VirtualMachinesReimageFuture, err error)
Reimage reimages the virtual machine which has an ephemeral OS disk back to its initial state. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Reimage Virtual Machine operation.
func (client VirtualMachinesClient) ReimagePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters *VirtualMachineReimageParameters) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (client VirtualMachinesClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)
ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ReimageSender(req *http.Request) (future VirtualMachinesReimageFuture, err error)
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Restart(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesRestartFuture, err error)
Restart the operation to restart a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) RestartPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachinesClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RestartSender(req *http.Request) (future VirtualMachinesRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) RetrieveBootDiagnosticsData(ctx context.Context, resourceGroupName string, VMName string, sasURIExpirationTimeInMinutes *int32) (result RetrieveBootDiagnosticsDataResult, err error)
RetrieveBootDiagnosticsData the operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. sasURIExpirationTimeInMinutes - expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. <br><br>NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes.
func (client VirtualMachinesClient) RetrieveBootDiagnosticsDataPreparer(ctx context.Context, resourceGroupName string, VMName string, sasURIExpirationTimeInMinutes *int32) (*http.Request, error)
RetrieveBootDiagnosticsDataPreparer prepares the RetrieveBootDiagnosticsData request.
func (client VirtualMachinesClient) RetrieveBootDiagnosticsDataResponder(resp *http.Response) (result RetrieveBootDiagnosticsDataResult, err error)
RetrieveBootDiagnosticsDataResponder handles the response to the RetrieveBootDiagnosticsData request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RetrieveBootDiagnosticsDataSender(req *http.Request) (*http.Response, error)
RetrieveBootDiagnosticsDataSender sends the RetrieveBootDiagnosticsData request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) RunCommand(ctx context.Context, resourceGroupName string, VMName string, parameters RunCommandInput) (result VirtualMachinesRunCommandFuture, err error)
RunCommand run command on the VM. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Run command operation.
func (client VirtualMachinesClient) RunCommandPreparer(ctx context.Context, resourceGroupName string, VMName string, parameters RunCommandInput) (*http.Request, error)
RunCommandPreparer prepares the RunCommand request.
func (client VirtualMachinesClient) RunCommandResponder(resp *http.Response) (result RunCommandResult, err error)
RunCommandResponder handles the response to the RunCommand request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RunCommandSender(req *http.Request) (future VirtualMachinesRunCommandFuture, err error)
RunCommandSender sends the RunCommand request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) SimulateEviction(ctx context.Context, resourceGroupName string, VMName string) (result autorest.Response, err error)
SimulateEviction the operation to simulate the eviction of spot virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) SimulateEvictionPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
SimulateEvictionPreparer prepares the SimulateEviction request.
func (client VirtualMachinesClient) SimulateEvictionResponder(resp *http.Response) (result autorest.Response, err error)
SimulateEvictionResponder handles the response to the SimulateEviction request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) SimulateEvictionSender(req *http.Request) (*http.Response, error)
SimulateEvictionSender sends the SimulateEviction request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Start(ctx context.Context, resourceGroupName string, VMName string) (result VirtualMachinesStartFuture, err error)
Start the operation to start a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine.
func (client VirtualMachinesClient) StartPreparer(ctx context.Context, resourceGroupName string, VMName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachinesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) StartSender(req *http.Request) (future VirtualMachinesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Update(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineUpdate) (result VirtualMachinesUpdateFuture, err error)
Update the operation to update a virtual machine. Parameters: resourceGroupName - the name of the resource group. VMName - the name of the virtual machine. parameters - parameters supplied to the Update Virtual Machine operation.
func (client VirtualMachinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, VMName string, parameters VirtualMachineUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachinesClient) UpdateResponder(resp *http.Response) (result VirtualMachine, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) UpdateSender(req *http.Request) (future VirtualMachinesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachinesConvertToManagedDisksFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesConvertToManagedDisksFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesConvertToManagedDisksFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachine, error)
}
func (future *VirtualMachinesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDeallocateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDeallocateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesDeallocateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesInstallPatchesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesInstallPatchesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachineInstallPatchesResult, error)
}
func (future *VirtualMachinesInstallPatchesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesPerformMaintenanceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesPerformMaintenanceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesPerformMaintenanceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesPowerOffFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesPowerOffFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesPowerOffFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesReapplyFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesReapplyFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesReapplyFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRedeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRedeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesRedeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesReimageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesReimageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesReimageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRunCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRunCommandFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (RunCommandResult, error)
}
func (future *VirtualMachinesRunCommandFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (VirtualMachine, error)
}
func (future *VirtualMachinesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
WinRMConfiguration describes Windows Remote Management configuration of the VM
type WinRMConfiguration struct {
// Listeners - The list of Windows Remote Management listeners
Listeners *[]WinRMListener `json:"listeners,omitempty"`
}
WinRMListener describes Protocol and thumbprint of Windows Remote Management listener
type WinRMListener struct {
// Protocol - Specifies the protocol of WinRM listener. <br><br> Possible values are: <br>**http** <br><br> **https**. Possible values include: 'ProtocolTypesHTTP', 'ProtocolTypesHTTPS'
Protocol ProtocolTypes `json:"protocol,omitempty"`
// CertificateURL - This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br> "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).
CertificateURL *string `json:"certificateUrl,omitempty"`
}
WindowsConfiguration specifies Windows operating system settings on the virtual machine.
type WindowsConfiguration struct {
// ProvisionVMAgent - Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ProvisionVMAgent *bool `json:"provisionVMAgent,omitempty"`
// EnableAutomaticUpdates - Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. <br><br> For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
EnableAutomaticUpdates *bool `json:"enableAutomaticUpdates,omitempty"`
// TimeZone - Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". <br><br> Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones).
TimeZone *string `json:"timeZone,omitempty"`
// AdditionalUnattendContent - Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
AdditionalUnattendContent *[]AdditionalUnattendContent `json:"additionalUnattendContent,omitempty"`
// PatchSettings - [Preview Feature] Specifies settings related to VM Guest Patching on Windows.
PatchSettings *PatchSettings `json:"patchSettings,omitempty"`
// WinRM - Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
WinRM *WinRMConfiguration `json:"winRM,omitempty"`
}
WindowsParameters input for InstallPatches on a Windows VM, as directly received by the API
type WindowsParameters struct {
// ClassificationsToInclude - The update classifications to select when installing patches for Windows.
ClassificationsToInclude *[]VMGuestPatchClassificationWindows `json:"classificationsToInclude,omitempty"`
// KbNumbersToInclude - Kbs to include in the patch operation
KbNumbersToInclude *[]string `json:"kbNumbersToInclude,omitempty"`
// KbNumbersToExclude - Kbs to exclude in the patch operation
KbNumbersToExclude *[]string `json:"kbNumbersToExclude,omitempty"`
// ExcludeKbsRequiringReboot - Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true.
ExcludeKbsRequiringReboot *bool `json:"excludeKbsRequiringReboot,omitempty"`
// MaxPatchPublishDate - This is used to install patches that were published on or before this given max published date.
MaxPatchPublishDate *date.Time `json:"maxPatchPublishDate,omitempty"`
}
WindowsPatchAssessmentMode enumerates the values for windows patch assessment mode.
type WindowsPatchAssessmentMode string
const (
// WindowsPatchAssessmentModeAutomaticByPlatform ...
WindowsPatchAssessmentModeAutomaticByPlatform WindowsPatchAssessmentMode = "AutomaticByPlatform"
// WindowsPatchAssessmentModeImageDefault ...
WindowsPatchAssessmentModeImageDefault WindowsPatchAssessmentMode = "ImageDefault"
)
func PossibleWindowsPatchAssessmentModeValues() []WindowsPatchAssessmentMode
PossibleWindowsPatchAssessmentModeValues returns an array of possible values for the WindowsPatchAssessmentMode const type.
WindowsVMGuestPatchMode enumerates the values for windows vm guest patch mode.
type WindowsVMGuestPatchMode string
const (
// WindowsVMGuestPatchModeAutomaticByOS ...
WindowsVMGuestPatchModeAutomaticByOS WindowsVMGuestPatchMode = "AutomaticByOS"
// WindowsVMGuestPatchModeAutomaticByPlatform ...
WindowsVMGuestPatchModeAutomaticByPlatform WindowsVMGuestPatchMode = "AutomaticByPlatform"
// WindowsVMGuestPatchModeManual ...
WindowsVMGuestPatchModeManual WindowsVMGuestPatchMode = "Manual"
)
func PossibleWindowsVMGuestPatchModeValues() []WindowsVMGuestPatchMode
PossibleWindowsVMGuestPatchModeValues returns an array of possible values for the WindowsVMGuestPatchMode const type.
| Name | Synopsis |
|---|---|
| .. | |
| computeapi | Deprecated: Please note, this package has been deprecated. |