import "github.com/Azure/azure-sdk-for-go/services/preview/sqlvirtualmachine/mgmt/2017-03-01-preview/sqlvirtualmachine"
Package sqlvirtualmachine implements the Azure ARM Sqlvirtualmachine service API version 2017-03-01-preview.
The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.
availabilitygrouplisteners.go client.go groups.go models.go operations.go sqlvirtualmachines.go version.go
const (
// DefaultBaseURI is the default URI used for the service Sqlvirtualmachine
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type AdditionalFeaturesServerConfigurations struct {
// IsRServicesEnabled - Enable or disable R services (SQL 2016 onwards).
IsRServicesEnabled *bool `json:"isRServicesEnabled,omitempty"`
}AdditionalFeaturesServerConfigurations additional SQL Server feature settings.
type AutoBackupSettings struct {
// Enable - Enable or disable autobackup on SQL virtual machine.
Enable *bool `json:"enable,omitempty"`
// EnableEncryption - Enable or disable encryption for backup on SQL virtual machine.
EnableEncryption *bool `json:"enableEncryption,omitempty"`
// RetentionPeriod - Retention period of backup: 1-30 days.
RetentionPeriod *int32 `json:"retentionPeriod,omitempty"`
// StorageAccountURL - Storage account url where backup will be taken to.
StorageAccountURL *string `json:"storageAccountUrl,omitempty"`
// StorageAccessKey - Storage account key where backup will be taken to.
StorageAccessKey *string `json:"storageAccessKey,omitempty"`
// Password - Password for encryption on backup.
Password *string `json:"password,omitempty"`
// BackupSystemDbs - Include or exclude system databases from auto backup.
BackupSystemDbs *bool `json:"backupSystemDbs,omitempty"`
// BackupScheduleType - Backup schedule type. Possible values include: 'Manual', 'Automated'
BackupScheduleType BackupScheduleType `json:"backupScheduleType,omitempty"`
// FullBackupFrequency - Frequency of full backups. In both cases, full backups begin during the next scheduled time window. Possible values include: 'Daily', 'Weekly'
FullBackupFrequency FullBackupFrequencyType `json:"fullBackupFrequency,omitempty"`
// FullBackupStartTime - Start time of a given day during which full backups can take place. 0-23 hours.
FullBackupStartTime *int32 `json:"fullBackupStartTime,omitempty"`
// FullBackupWindowHours - Duration of the time window of a given day during which full backups can take place. 1-23 hours.
FullBackupWindowHours *int32 `json:"fullBackupWindowHours,omitempty"`
// LogBackupFrequency - Frequency of log backups. 5-60 minutes.
LogBackupFrequency *int32 `json:"logBackupFrequency,omitempty"`
}AutoBackupSettings configure backups for databases in your SQL virtual machine.
type AutoPatchingSettings struct {
// Enable - Enable or disable autopatching on SQL virtual machine.
Enable *bool `json:"enable,omitempty"`
// DayOfWeek - Day of week to apply the patch on. Possible values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'
DayOfWeek DayOfWeek `json:"dayOfWeek,omitempty"`
// MaintenanceWindowStartingHour - Hour of the day when patching is initiated. Local VM time.
MaintenanceWindowStartingHour *int32 `json:"maintenanceWindowStartingHour,omitempty"`
// MaintenanceWindowDuration - Duration of patching.
MaintenanceWindowDuration *int32 `json:"maintenanceWindowDuration,omitempty"`
}AutoPatchingSettings set a patching window during which Windows and SQL patches will be applied.
type AvailabilityGroupListener struct {
autorest.Response `json:"-"`
// AvailabilityGroupListenerProperties - Resource properties.
*AvailabilityGroupListenerProperties `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"`
}AvailabilityGroupListener a SQL Server availability group listener.
func (agl AvailabilityGroupListener) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilityGroupListener.
func (agl *AvailabilityGroupListener) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilityGroupListener struct.
type AvailabilityGroupListenerListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]AvailabilityGroupListener `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}AvailabilityGroupListenerListResult a list of availability group listeners.
func (agllr AvailabilityGroupListenerListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AvailabilityGroupListenerListResultIterator struct {
// contains filtered or unexported fields
}AvailabilityGroupListenerListResultIterator provides access to a complete listing of AvailabilityGroupListener values.
func NewAvailabilityGroupListenerListResultIterator(page AvailabilityGroupListenerListResultPage) AvailabilityGroupListenerListResultIterator
Creates a new instance of the AvailabilityGroupListenerListResultIterator type.
func (iter *AvailabilityGroupListenerListResultIterator) 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 *AvailabilityGroupListenerListResultIterator) 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 AvailabilityGroupListenerListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AvailabilityGroupListenerListResultIterator) Response() AvailabilityGroupListenerListResult
Response returns the raw server response from the last page request.
func (iter AvailabilityGroupListenerListResultIterator) Value() AvailabilityGroupListener
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AvailabilityGroupListenerListResultPage struct {
// contains filtered or unexported fields
}AvailabilityGroupListenerListResultPage contains a page of AvailabilityGroupListener values.
func NewAvailabilityGroupListenerListResultPage(getNextPage func(context.Context, AvailabilityGroupListenerListResult) (AvailabilityGroupListenerListResult, error)) AvailabilityGroupListenerListResultPage
Creates a new instance of the AvailabilityGroupListenerListResultPage type.
func (page *AvailabilityGroupListenerListResultPage) 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 *AvailabilityGroupListenerListResultPage) 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 AvailabilityGroupListenerListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AvailabilityGroupListenerListResultPage) Response() AvailabilityGroupListenerListResult
Response returns the raw server response from the last page request.
func (page AvailabilityGroupListenerListResultPage) Values() []AvailabilityGroupListener
Values returns the slice of values for the current page or nil if there are no values.
type AvailabilityGroupListenerProperties struct {
// ProvisioningState - READ-ONLY; Provisioning state to track the async operation status.
ProvisioningState *string `json:"provisioningState,omitempty"`
// AvailabilityGroupName - Name of the availability group.
AvailabilityGroupName *string `json:"availabilityGroupName,omitempty"`
// LoadBalancerConfigurations - List of load balancer configurations for an availability group listener.
LoadBalancerConfigurations *[]LoadBalancerConfiguration `json:"loadBalancerConfigurations,omitempty"`
// CreateDefaultAvailabilityGroupIfNotExist - Create a default availability group if it does not exist.
CreateDefaultAvailabilityGroupIfNotExist *bool `json:"createDefaultAvailabilityGroupIfNotExist,omitempty"`
// Port - Listener port.
Port *int32 `json:"port,omitempty"`
}AvailabilityGroupListenerProperties the properties of an availability group listener.
type AvailabilityGroupListenersClient struct {
BaseClient
}AvailabilityGroupListenersClient is the the SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.
func NewAvailabilityGroupListenersClient(subscriptionID string) AvailabilityGroupListenersClient
NewAvailabilityGroupListenersClient creates an instance of the AvailabilityGroupListenersClient client.
func NewAvailabilityGroupListenersClientWithBaseURI(baseURI string, subscriptionID string) AvailabilityGroupListenersClient
NewAvailabilityGroupListenersClientWithBaseURI creates an instance of the AvailabilityGroupListenersClient client.
func (client AvailabilityGroupListenersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string, parameters AvailabilityGroupListener) (result AvailabilityGroupListenersCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an availability group listener. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group. availabilityGroupListenerName - name of the availability group listener. parameters - the availability group listener.
func (client AvailabilityGroupListenersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string, parameters AvailabilityGroupListener) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AvailabilityGroupListenersClient) CreateOrUpdateResponder(resp *http.Response) (result AvailabilityGroupListener, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AvailabilityGroupListenersClient) CreateOrUpdateSender(req *http.Request) (future AvailabilityGroupListenersCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AvailabilityGroupListenersClient) Delete(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string) (result AvailabilityGroupListenersDeleteFuture, err error)
Delete deletes an availability group listener. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group. availabilityGroupListenerName - name of the availability group listener.
func (client AvailabilityGroupListenersClient) DeletePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client AvailabilityGroupListenersClient) 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 AvailabilityGroupListenersClient) DeleteSender(req *http.Request) (future AvailabilityGroupListenersDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AvailabilityGroupListenersClient) Get(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string) (result AvailabilityGroupListener, err error)
Get gets an availability group listener. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group. availabilityGroupListenerName - name of the availability group listener.
func (client AvailabilityGroupListenersClient) GetPreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, availabilityGroupListenerName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AvailabilityGroupListenersClient) GetResponder(resp *http.Response) (result AvailabilityGroupListener, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client AvailabilityGroupListenersClient) 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 AvailabilityGroupListenersClient) ListByGroup(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (result AvailabilityGroupListenerListResultPage, err error)
ListByGroup lists all availability group listeners in a SQL virtual machine group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group.
func (client AvailabilityGroupListenersClient) ListByGroupComplete(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (result AvailabilityGroupListenerListResultIterator, err error)
ListByGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilityGroupListenersClient) ListByGroupPreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (*http.Request, error)
ListByGroupPreparer prepares the ListByGroup request.
func (client AvailabilityGroupListenersClient) ListByGroupResponder(resp *http.Response) (result AvailabilityGroupListenerListResult, err error)
ListByGroupResponder handles the response to the ListByGroup request. The method always closes the http.Response Body.
func (client AvailabilityGroupListenersClient) ListByGroupSender(req *http.Request) (*http.Response, error)
ListByGroupSender sends the ListByGroup request. The method will close the http.Response Body if it receives an error.
AvailabilityGroupListenersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *AvailabilityGroupListenersCreateOrUpdateFuture) Result(client AvailabilityGroupListenersClient) (agl AvailabilityGroupListener, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
AvailabilityGroupListenersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *AvailabilityGroupListenersDeleteFuture) Result(client AvailabilityGroupListenersClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
BackupScheduleType enumerates the values for backup schedule type.
const (
// Automated ...
Automated BackupScheduleType = "Automated"
// Manual ...
Manual BackupScheduleType = "Manual"
)func PossibleBackupScheduleTypeValues() []BackupScheduleType
PossibleBackupScheduleTypeValues returns an array of possible values for the BackupScheduleType const type.
BaseClient is the base client for Sqlvirtualmachine.
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.
ClusterConfiguration enumerates the values for cluster configuration.
const (
// Domainful ...
Domainful ClusterConfiguration = "Domainful"
)func PossibleClusterConfigurationValues() []ClusterConfiguration
PossibleClusterConfigurationValues returns an array of possible values for the ClusterConfiguration const type.
ClusterManagerType enumerates the values for cluster manager type.
const (
// WSFC ...
WSFC ClusterManagerType = "WSFC"
)func PossibleClusterManagerTypeValues() []ClusterManagerType
PossibleClusterManagerTypeValues returns an array of possible values for the ClusterManagerType const type.
ConnectivityType enumerates the values for connectivity type.
const (
// LOCAL ...
LOCAL ConnectivityType = "LOCAL"
// PRIVATE ...
PRIVATE ConnectivityType = "PRIVATE"
// PUBLIC ...
PUBLIC ConnectivityType = "PUBLIC"
)func PossibleConnectivityTypeValues() []ConnectivityType
PossibleConnectivityTypeValues returns an array of possible values for the ConnectivityType const type.
DayOfWeek enumerates the values for day of week.
const (
// Friday ...
Friday DayOfWeek = "Friday"
// Monday ...
Monday DayOfWeek = "Monday"
// Saturday ...
Saturday DayOfWeek = "Saturday"
// Sunday ...
Sunday DayOfWeek = "Sunday"
// Thursday ...
Thursday DayOfWeek = "Thursday"
// Tuesday ...
Tuesday DayOfWeek = "Tuesday"
// Wednesday ...
Wednesday DayOfWeek = "Wednesday"
)PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.
DiskConfigurationType enumerates the values for disk configuration type.
const (
// ADD ...
ADD DiskConfigurationType = "ADD"
// EXTEND ...
EXTEND DiskConfigurationType = "EXTEND"
// NEW ...
NEW DiskConfigurationType = "NEW"
)func PossibleDiskConfigurationTypeValues() []DiskConfigurationType
PossibleDiskConfigurationTypeValues returns an array of possible values for the DiskConfigurationType const type.
FullBackupFrequencyType enumerates the values for full backup frequency type.
const (
// Daily ...
Daily FullBackupFrequencyType = "Daily"
// Weekly ...
Weekly FullBackupFrequencyType = "Weekly"
)func PossibleFullBackupFrequencyTypeValues() []FullBackupFrequencyType
PossibleFullBackupFrequencyTypeValues returns an array of possible values for the FullBackupFrequencyType const type.
type Group struct {
autorest.Response `json:"-"`
// GroupProperties - Resource properties.
*GroupProperties `json:"properties,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// 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"`
}Group a SQL virtual machine group.
MarshalJSON is the custom marshaler for Group.
UnmarshalJSON is the custom unmarshaler for Group struct.
type GroupListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]Group `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}GroupListResult a list of SQL virtual machine groups.
func (glr GroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GroupListResultIterator struct {
// contains filtered or unexported fields
}GroupListResultIterator provides access to a complete listing of Group values.
func NewGroupListResultIterator(page GroupListResultPage) GroupListResultIterator
Creates a new instance of the GroupListResultIterator type.
func (iter *GroupListResultIterator) 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 *GroupListResultIterator) 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 GroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GroupListResultIterator) Response() GroupListResult
Response returns the raw server response from the last page request.
func (iter GroupListResultIterator) Value() Group
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GroupListResultPage struct {
// contains filtered or unexported fields
}GroupListResultPage contains a page of Group values.
func NewGroupListResultPage(getNextPage func(context.Context, GroupListResult) (GroupListResult, error)) GroupListResultPage
Creates a new instance of the GroupListResultPage type.
func (page *GroupListResultPage) 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 *GroupListResultPage) 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 GroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GroupListResultPage) Response() GroupListResult
Response returns the raw server response from the last page request.
func (page GroupListResultPage) Values() []Group
Values returns the slice of values for the current page or nil if there are no values.
type GroupProperties struct {
// ProvisioningState - READ-ONLY; Provisioning state to track the async operation status.
ProvisioningState *string `json:"provisioningState,omitempty"`
// SQLImageOffer - SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
SQLImageOffer *string `json:"sqlImageOffer,omitempty"`
// SQLImageSku - SQL image sku. Possible values include: 'SQLVMGroupImageSkuDeveloper', 'SQLVMGroupImageSkuEnterprise'
SQLImageSku SQLVMGroupImageSku `json:"sqlImageSku,omitempty"`
// ScaleType - READ-ONLY; Scale type. Possible values include: 'HA'
ScaleType ScaleType `json:"scaleType,omitempty"`
// ClusterManagerType - READ-ONLY; Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. Possible values include: 'WSFC'
ClusterManagerType ClusterManagerType `json:"clusterManagerType,omitempty"`
// ClusterConfiguration - READ-ONLY; Cluster type. Possible values include: 'Domainful'
ClusterConfiguration ClusterConfiguration `json:"clusterConfiguration,omitempty"`
// WsfcDomainProfile - Cluster Active Directory domain profile.
WsfcDomainProfile *WsfcDomainProfile `json:"wsfcDomainProfile,omitempty"`
}GroupProperties the properties of a SQL virtual machine group.
GroupUpdate an update to a SQL virtual machine group.
func (gu GroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupUpdate.
type GroupsClient struct {
BaseClient
}GroupsClient is the the SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.
func NewGroupsClient(subscriptionID string) GroupsClient
NewGroupsClient creates an instance of the GroupsClient client.
func NewGroupsClientWithBaseURI(baseURI string, subscriptionID string) GroupsClient
NewGroupsClientWithBaseURI creates an instance of the GroupsClient client.
func (client GroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, parameters Group) (result GroupsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a SQL virtual machine group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group. parameters - the SQL virtual machine group.
func (client GroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, parameters Group) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GroupsClient) CreateOrUpdateSender(req *http.Request) (future GroupsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GroupsClient) Delete(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (result GroupsDeleteFuture, err error)
Delete deletes a SQL virtual machine group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group.
func (client GroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GroupsClient) 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 GroupsClient) DeleteSender(req *http.Request) (future GroupsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GroupsClient) Get(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (result Group, err error)
Get gets a SQL virtual machine group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group.
func (client GroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GroupsClient) List(ctx context.Context) (result GroupListResultPage, err error)
List gets all SQL virtual machine groups in a subscription.
func (client GroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result GroupListResultPage, err error)
ListByResourceGroup gets all SQL virtual machine groups in a resource group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
func (client GroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result GroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client GroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client GroupsClient) ListByResourceGroupResponder(resp *http.Response) (result GroupListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client GroupsClient) ListComplete(ctx context.Context) (result GroupListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client GroupsClient) ListResponder(resp *http.Response) (result GroupListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client GroupsClient) Update(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, parameters GroupUpdate) (result GroupsUpdateFuture, err error)
Update updates SQL virtual machine group tags. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineGroupName - name of the SQL virtual machine group. parameters - the SQL virtual machine group.
func (client GroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineGroupName string, parameters GroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GroupsClient) UpdateSender(req *http.Request) (future GroupsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GroupsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *GroupsCreateOrUpdateFuture) Result(client GroupsClient) (g Group, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
GroupsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *GroupsDeleteFuture) Result(client GroupsClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
GroupsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *GroupsUpdateFuture) Result(client GroupsClient) (g Group, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
IdentityType enumerates the values for identity type.
const (
// SystemAssigned ...
SystemAssigned IdentityType = "SystemAssigned"
)func PossibleIdentityTypeValues() []IdentityType
PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.
type KeyVaultCredentialSettings struct {
// Enable - Enable or disable key vault credential setting.
Enable *bool `json:"enable,omitempty"`
// CredentialName - Credential name.
CredentialName *string `json:"credentialName,omitempty"`
// AzureKeyVaultURL - Azure Key Vault url.
AzureKeyVaultURL *string `json:"azureKeyVaultUrl,omitempty"`
// ServicePrincipalName - Service principal name to access key vault.
ServicePrincipalName *string `json:"servicePrincipalName,omitempty"`
// ServicePrincipalSecret - Service principal name secret to access key vault.
ServicePrincipalSecret *string `json:"servicePrincipalSecret,omitempty"`
}KeyVaultCredentialSettings configure your SQL virtual machine to be able to connect to the Azure Key Vault service.
type ListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]SQLVirtualMachine `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}ListResult a list of SQL virtual machines.
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListResultIterator struct {
// contains filtered or unexported fields
}ListResultIterator provides access to a complete listing of SQLVirtualMachine values.
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
func (iter *ListResultIterator) 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 *ListResultIterator) 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 ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
func (iter ListResultIterator) Value() SQLVirtualMachine
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListResultPage struct {
// contains filtered or unexported fields
}ListResultPage contains a page of SQLVirtualMachine values.
func NewListResultPage(getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
func (page *ListResultPage) 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 *ListResultPage) 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 ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []SQLVirtualMachine
Values returns the slice of values for the current page or nil if there are no values.
type LoadBalancerConfiguration struct {
// PrivateIPAddress - Private IP address.
PrivateIPAddress *PrivateIPAddress `json:"privateIpAddress,omitempty"`
// PublicIPAddressResourceID - Resource id of the public IP.
PublicIPAddressResourceID *string `json:"publicIpAddressResourceId,omitempty"`
// LoadBalancerResourceID - Resource id of the load balancer.
LoadBalancerResourceID *string `json:"loadBalancerResourceId,omitempty"`
// ProbePort - Probe port.
ProbePort *int32 `json:"probePort,omitempty"`
// SQLVirtualMachineInstances - List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.
SQLVirtualMachineInstances *[]string `json:"sqlVirtualMachineInstances,omitempty"`
}LoadBalancerConfiguration a load balancer configuration for an availability group listener.
type Operation struct {
// Name - READ-ONLY; The name of the operation being performed on this particular object.
Name *string `json:"name,omitempty"`
// Display - READ-ONLY; The localized display information for this particular operation / action.
Display *OperationDisplay `json:"display,omitempty"`
// Origin - READ-ONLY; The intended executor of the operation. Possible values include: 'User', 'System'
Origin OperationOrigin `json:"origin,omitempty"`
// Properties - READ-ONLY; Additional descriptions for the operation.
Properties map[string]interface{} `json:"properties"`
}Operation SQL REST API operation definition.
MarshalJSON is the custom marshaler for Operation.
type OperationDisplay struct {
// Provider - READ-ONLY; The localized friendly form of the resource provider name.
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; The localized friendly form of the resource type related to this action/operation.
Resource *string `json:"resource,omitempty"`
// Operation - READ-ONLY; The localized friendly name for the operation.
Operation *string `json:"operation,omitempty"`
// Description - READ-ONLY; The localized friendly description for the operation.
Description *string `json:"description,omitempty"`
}OperationDisplay display metadata associated with the operation.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}OperationListResult result of the request to list SQL operations.
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) 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 *OperationListResultIterator) 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 OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage struct {
// contains filtered or unexported fields
}OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) 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 *OperationListResultPage) 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 OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationOrigin enumerates the values for operation origin.
const (
// System ...
System OperationOrigin = "system"
// User ...
User OperationOrigin = "user"
)func PossibleOperationOriginValues() []OperationOrigin
PossibleOperationOriginValues returns an array of possible values for the OperationOrigin const type.
type OperationsClient struct {
BaseClient
}OperationsClient is the the SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.
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.
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available SQL Rest API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PrivateIPAddress struct {
// IPAddress - Private IP address bound to the availability group listener.
IPAddress *string `json:"ipAddress,omitempty"`
// SubnetResourceID - Subnet used to include private IP.
SubnetResourceID *string `json:"subnetResourceId,omitempty"`
}PrivateIPAddress a private IP address bound to the availability group listener.
type Properties struct {
// VirtualMachineResourceID - ARM Resource id of underlying virtual machine created from SQL marketplace image.
VirtualMachineResourceID *string `json:"virtualMachineResourceId,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state to track the async operation status.
ProvisioningState *string `json:"provisioningState,omitempty"`
// SQLImageOffer - SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.
SQLImageOffer *string `json:"sqlImageOffer,omitempty"`
// SQLServerLicenseType - SQL Server license type. Possible values include: 'PAYG', 'AHUB'
SQLServerLicenseType SQLServerLicenseType `json:"sqlServerLicenseType,omitempty"`
// SQLManagement - SQL Server Management type. Possible values include: 'Full', 'LightWeight', 'NoAgent'
SQLManagement SQLManagementMode `json:"sqlManagement,omitempty"`
// SQLImageSku - SQL Server edition type. Possible values include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web'
SQLImageSku SQLImageSku `json:"sqlImageSku,omitempty"`
// SQLVirtualMachineGroupResourceID - ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.
SQLVirtualMachineGroupResourceID *string `json:"sqlVirtualMachineGroupResourceId,omitempty"`
// WsfcDomainCredentials - Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
WsfcDomainCredentials *WsfcDomainCredentials `json:"wsfcDomainCredentials,omitempty"`
// AutoPatchingSettings - Auto patching settings for applying critical security updates to SQL virtual machine.
AutoPatchingSettings *AutoPatchingSettings `json:"autoPatchingSettings,omitempty"`
// AutoBackupSettings - Auto backup settings for SQL Server.
AutoBackupSettings *AutoBackupSettings `json:"autoBackupSettings,omitempty"`
// KeyVaultCredentialSettings - Key vault credential settings.
KeyVaultCredentialSettings *KeyVaultCredentialSettings `json:"keyVaultCredentialSettings,omitempty"`
// ServerConfigurationsManagementSettings - SQL Server configuration management settings.
ServerConfigurationsManagementSettings *ServerConfigurationsManagementSettings `json:"serverConfigurationsManagementSettings,omitempty"`
}Properties the SQL virtual machine properties.
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"`
}ProxyResource ARM proxy resource.
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"`
}Resource ARM resource.
type ResourceIdentity struct {
// PrincipalID - READ-ONLY; The Azure Active Directory principal id.
PrincipalID *uuid.UUID `json:"principalId,omitempty"`
// Type - The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. Possible values include: 'SystemAssigned'
Type IdentityType `json:"type,omitempty"`
// TenantID - READ-ONLY; The Azure Active Directory tenant id.
TenantID *uuid.UUID `json:"tenantId,omitempty"`
}ResourceIdentity azure Active Directory identity configuration for a resource.
type SQLConnectivityUpdateSettings struct {
// ConnectivityType - SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', 'PUBLIC'
ConnectivityType ConnectivityType `json:"connectivityType,omitempty"`
// Port - SQL Server port.
Port *int32 `json:"port,omitempty"`
// SQLAuthUpdateUserName - SQL Server sysadmin login to create.
SQLAuthUpdateUserName *string `json:"sqlAuthUpdateUserName,omitempty"`
// SQLAuthUpdatePassword - SQL Server sysadmin login password.
SQLAuthUpdatePassword *string `json:"sqlAuthUpdatePassword,omitempty"`
}SQLConnectivityUpdateSettings set the access level and network port settings for SQL Server.
SQLImageSku enumerates the values for sql image sku.
const (
// Developer ...
Developer SQLImageSku = "Developer"
// Enterprise ...
Enterprise SQLImageSku = "Enterprise"
// Express ...
Express SQLImageSku = "Express"
// Standard ...
Standard SQLImageSku = "Standard"
// Web ...
Web SQLImageSku = "Web"
)func PossibleSQLImageSkuValues() []SQLImageSku
PossibleSQLImageSkuValues returns an array of possible values for the SQLImageSku const type.
SQLManagementMode enumerates the values for sql management mode.
const (
// Full ...
Full SQLManagementMode = "Full"
// LightWeight ...
LightWeight SQLManagementMode = "LightWeight"
// NoAgent ...
NoAgent SQLManagementMode = "NoAgent"
)func PossibleSQLManagementModeValues() []SQLManagementMode
PossibleSQLManagementModeValues returns an array of possible values for the SQLManagementMode const type.
SQLServerLicenseType enumerates the values for sql server license type.
const (
// AHUB ...
AHUB SQLServerLicenseType = "AHUB"
// PAYG ...
PAYG SQLServerLicenseType = "PAYG"
)func PossibleSQLServerLicenseTypeValues() []SQLServerLicenseType
PossibleSQLServerLicenseTypeValues returns an array of possible values for the SQLServerLicenseType const type.
type SQLStorageUpdateSettings struct {
// DiskCount - Virtual machine disk count.
DiskCount *int32 `json:"diskCount,omitempty"`
// StartingDeviceID - Device id of the first disk to be updated.
StartingDeviceID *int32 `json:"startingDeviceId,omitempty"`
// DiskConfigurationType - Disk configuration to apply to SQL Server. Possible values include: 'NEW', 'EXTEND', 'ADD'
DiskConfigurationType DiskConfigurationType `json:"diskConfigurationType,omitempty"`
}SQLStorageUpdateSettings set disk storage settings for SQL Server.
SQLVMGroupImageSku enumerates the values for sqlvm group image sku.
const (
// SQLVMGroupImageSkuDeveloper ...
SQLVMGroupImageSkuDeveloper SQLVMGroupImageSku = "Developer"
// SQLVMGroupImageSkuEnterprise ...
SQLVMGroupImageSkuEnterprise SQLVMGroupImageSku = "Enterprise"
)func PossibleSQLVMGroupImageSkuValues() []SQLVMGroupImageSku
PossibleSQLVMGroupImageSkuValues returns an array of possible values for the SQLVMGroupImageSku const type.
type SQLVirtualMachine struct {
autorest.Response `json:"-"`
// Identity - Azure Active Directory identity of the server.
Identity *ResourceIdentity `json:"identity,omitempty"`
// Properties - Resource properties.
*Properties `json:"properties,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// 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"`
}SQLVirtualMachine a SQL virtual machine.
func (svm SQLVirtualMachine) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLVirtualMachine.
func (svm *SQLVirtualMachine) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLVirtualMachine struct.
type SQLVirtualMachinesClient struct {
BaseClient
}SQLVirtualMachinesClient is the the SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.
func NewSQLVirtualMachinesClient(subscriptionID string) SQLVirtualMachinesClient
NewSQLVirtualMachinesClient creates an instance of the SQLVirtualMachinesClient client.
func NewSQLVirtualMachinesClientWithBaseURI(baseURI string, subscriptionID string) SQLVirtualMachinesClient
NewSQLVirtualMachinesClientWithBaseURI creates an instance of the SQLVirtualMachinesClient client.
func (client SQLVirtualMachinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, parameters SQLVirtualMachine) (result SQLVirtualMachinesCreateOrUpdateFutureType, err error)
CreateOrUpdate creates or updates a SQL virtual machine. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineName - name of the SQL virtual machine. parameters - the SQL virtual machine.
func (client SQLVirtualMachinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, parameters SQLVirtualMachine) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SQLVirtualMachinesClient) CreateOrUpdateResponder(resp *http.Response) (result SQLVirtualMachine, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SQLVirtualMachinesClient) CreateOrUpdateSender(req *http.Request) (future SQLVirtualMachinesCreateOrUpdateFutureType, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SQLVirtualMachinesClient) Delete(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string) (result SQLVirtualMachinesDeleteFutureType, err error)
Delete deletes a SQL virtual machine. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineName - name of the SQL virtual machine.
func (client SQLVirtualMachinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SQLVirtualMachinesClient) 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 SQLVirtualMachinesClient) DeleteSender(req *http.Request) (future SQLVirtualMachinesDeleteFutureType, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SQLVirtualMachinesClient) Get(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, expand string) (result SQLVirtualMachine, err error)
Get gets a SQL virtual machine. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineName - name of the SQL virtual machine. expand - the child resources to include in the response.
func (client SQLVirtualMachinesClient) GetPreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SQLVirtualMachinesClient) GetResponder(resp *http.Response) (result SQLVirtualMachine, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SQLVirtualMachinesClient) List(ctx context.Context) (result ListResultPage, err error)
List gets all SQL virtual machines in a subscription.
func (client SQLVirtualMachinesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)
ListByResourceGroup gets all SQL virtual machines in a resource group. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
func (client SQLVirtualMachinesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client SQLVirtualMachinesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client SQLVirtualMachinesClient) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client SQLVirtualMachinesClient) 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 SQLVirtualMachinesClient) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client SQLVirtualMachinesClient) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SQLVirtualMachinesClient) Update(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, parameters Update) (result SQLVirtualMachinesUpdateFutureType, err error)
Update updates a SQL virtual machine. Parameters: resourceGroupName - name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. SQLVirtualMachineName - name of the SQL virtual machine. parameters - the SQL virtual machine.
func (client SQLVirtualMachinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, SQLVirtualMachineName string, parameters Update) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SQLVirtualMachinesClient) UpdateResponder(resp *http.Response) (result SQLVirtualMachine, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SQLVirtualMachinesClient) UpdateSender(req *http.Request) (future SQLVirtualMachinesUpdateFutureType, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SQLVirtualMachinesCreateOrUpdateFutureType an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SQLVirtualMachinesCreateOrUpdateFutureType) Result(client SQLVirtualMachinesClient) (svm SQLVirtualMachine, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SQLVirtualMachinesDeleteFutureType an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SQLVirtualMachinesDeleteFutureType) Result(client SQLVirtualMachinesClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SQLVirtualMachinesUpdateFutureType an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *SQLVirtualMachinesUpdateFutureType) Result(client SQLVirtualMachinesClient) (svm SQLVirtualMachine, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
SQLWorkloadType enumerates the values for sql workload type.
const (
// DW ...
DW SQLWorkloadType = "DW"
// GENERAL ...
GENERAL SQLWorkloadType = "GENERAL"
// OLTP ...
OLTP SQLWorkloadType = "OLTP"
)func PossibleSQLWorkloadTypeValues() []SQLWorkloadType
PossibleSQLWorkloadTypeValues returns an array of possible values for the SQLWorkloadType const type.
type SQLWorkloadTypeUpdateSettings struct {
// SQLWorkloadType - SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW'
SQLWorkloadType SQLWorkloadType `json:"sqlWorkloadType,omitempty"`
}SQLWorkloadTypeUpdateSettings set workload type to optimize storage for SQL Server.
ScaleType enumerates the values for scale type.
PossibleScaleTypeValues returns an array of possible values for the ScaleType const type.
type ServerConfigurationsManagementSettings struct {
// SQLConnectivityUpdateSettings - SQL connectivity type settings.
SQLConnectivityUpdateSettings *SQLConnectivityUpdateSettings `json:"sqlConnectivityUpdateSettings,omitempty"`
// SQLWorkloadTypeUpdateSettings - SQL workload type settings.
SQLWorkloadTypeUpdateSettings *SQLWorkloadTypeUpdateSettings `json:"sqlWorkloadTypeUpdateSettings,omitempty"`
// SQLStorageUpdateSettings - SQL storage update settings.
SQLStorageUpdateSettings *SQLStorageUpdateSettings `json:"sqlStorageUpdateSettings,omitempty"`
// AdditionalFeaturesServerConfigurations - Additional SQL feature settings.
AdditionalFeaturesServerConfigurations *AdditionalFeaturesServerConfigurations `json:"additionalFeaturesServerConfigurations,omitempty"`
}ServerConfigurationsManagementSettings set the connectivity, storage and workload settings.
type TrackedResource struct {
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// 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"`
}TrackedResource ARM tracked top level resource.
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
Update an update to a SQL virtual machine.
MarshalJSON is the custom marshaler for Update.
type WsfcDomainCredentials struct {
// ClusterBootstrapAccountPassword - Cluster bootstrap account password.
ClusterBootstrapAccountPassword *string `json:"clusterBootstrapAccountPassword,omitempty"`
// ClusterOperatorAccountPassword - Cluster operator account password.
ClusterOperatorAccountPassword *string `json:"clusterOperatorAccountPassword,omitempty"`
// SQLServiceAccountPassword - SQL service account password.
SQLServiceAccountPassword *string `json:"sqlServiceAccountPassword,omitempty"`
}WsfcDomainCredentials domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
type WsfcDomainProfile struct {
// DomainFqdn - Fully qualified name of the domain.
DomainFqdn *string `json:"domainFqdn,omitempty"`
// OuPath - Organizational Unit path in which the nodes and cluster will be present.
OuPath *string `json:"ouPath,omitempty"`
// ClusterBootstrapAccount - Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).
ClusterBootstrapAccount *string `json:"clusterBootstrapAccount,omitempty"`
// ClusterOperatorAccount - Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
ClusterOperatorAccount *string `json:"clusterOperatorAccount,omitempty"`
// SQLServiceAccount - Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
SQLServiceAccount *string `json:"sqlServiceAccount,omitempty"`
// FileShareWitnessPath - Optional path for fileshare witness.
*string `json:"fileShareWitnessPath,omitempty"`
// StorageAccountURL - Fully qualified ARM resource id of the witness storage account.
StorageAccountURL *string `json:"storageAccountUrl,omitempty"`
// StorageAccountPrimaryKey - Primary key of the witness storage account.
StorageAccountPrimaryKey *string `json:"storageAccountPrimaryKey,omitempty"`
}WsfcDomainProfile active Directory account details to operate Windows Server Failover Cluster.
| Path | Synopsis |
|---|---|
| sqlvirtualmachineapi |
Package sqlvirtualmachine imports 9 packages (graph) and is imported by 4 packages. Updated 2019-07-30. Refresh now. Tools for package owners.