import "github.com/Azure/azure-sdk-for-go/services/preview/sql/mgmt/2015-05-01-preview/sql"
Package sql implements the Azure ARM Sql service API version .
The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
capabilities.go client.go databaseblobauditingpolicies.go databases.go databasethreatdetectionpolicies.go databaseusages.go datamaskingpolicies.go datamaskingrules.go elasticpoolactivities.go elasticpooldatabaseactivities.go elasticpools.go encryptionprotectors.go enums.go failovergroups.go firewallrules.go geobackuppolicies.go managedinstances.go models.go operations.go recoverabledatabases.go replicationlinks.go restorabledroppeddatabases.go restorepoints.go serverazureadadministrators.go servercommunicationlinks.go serverconnectionpolicies.go serverkeys.go servers.go serverusages.go serviceobjectives.go servicetieradvisors.go subscriptionusages.go syncagents.go syncgroups.go syncmembers.go transparentdataencryptionactivities.go transparentdataencryptions.go version.go virtualclusters.go virtualnetworkrules.go
const (
// DefaultBaseURI is the default URI used for the service Sql
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.
AuthenticationType enumerates the values for authentication type.
const (
// ADPassword ...
ADPassword AuthenticationType = "ADPassword"
// SQL ...
SQL AuthenticationType = "SQL"
)func PossibleAuthenticationTypeValues() []AuthenticationType
PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.
BaseClient is the base client for Sql.
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).
BlobAuditingPolicyState enumerates the values for blob auditing policy state.
const (
// Disabled ...
Disabled BlobAuditingPolicyState = "Disabled"
// Enabled ...
Enabled BlobAuditingPolicyState = "Enabled"
)func PossibleBlobAuditingPolicyStateValues() []BlobAuditingPolicyState
PossibleBlobAuditingPolicyStateValues returns an array of possible values for the BlobAuditingPolicyState const type.
type CapabilitiesClient struct {
BaseClient
}CapabilitiesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewCapabilitiesClient(subscriptionID string) CapabilitiesClient
NewCapabilitiesClient creates an instance of the CapabilitiesClient client.
func NewCapabilitiesClientWithBaseURI(baseURI string, subscriptionID string) CapabilitiesClient
NewCapabilitiesClientWithBaseURI creates an instance of the CapabilitiesClient 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 CapabilitiesClient) ListByLocation(ctx context.Context, locationName string) (result LocationCapabilities, err error)
ListByLocation gets the subscription capabilities available for the specified location. Parameters: locationName - the location name whose capabilities are retrieved.
func (client CapabilitiesClient) ListByLocationPreparer(ctx context.Context, locationName string) (*http.Request, error)
ListByLocationPreparer prepares the ListByLocation request.
func (client CapabilitiesClient) ListByLocationResponder(resp *http.Response) (result LocationCapabilities, err error)
ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.
ListByLocationSender sends the ListByLocation request. The method will close the http.Response Body if it receives an error.
CapabilityStatus enumerates the values for capability status.
const (
// CapabilityStatusAvailable ...
CapabilityStatusAvailable CapabilityStatus = "Available"
// CapabilityStatusDefault ...
CapabilityStatusDefault CapabilityStatus = "Default"
// CapabilityStatusDisabled ...
CapabilityStatusDisabled CapabilityStatus = "Disabled"
// CapabilityStatusVisible ...
CapabilityStatusVisible CapabilityStatus = "Visible"
)func PossibleCapabilityStatusValues() []CapabilityStatus
PossibleCapabilityStatusValues returns an array of possible values for the CapabilityStatus const type.
CheckNameAvailabilityReason enumerates the values for check name availability reason.
const (
// AlreadyExists ...
AlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
// Invalid ...
Invalid CheckNameAvailabilityReason = "Invalid"
)func PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason
PossibleCheckNameAvailabilityReasonValues returns an array of possible values for the CheckNameAvailabilityReason const type.
type CheckNameAvailabilityRequest struct {
// Name - The name whose availability is to be checked.
Name *string `json:"name,omitempty"`
// Type - The type of resource that is used as the scope of the availability check.
Type *string `json:"type,omitempty"`
}CheckNameAvailabilityRequest a request to check whether the specified name for a resource is available.
type CheckNameAvailabilityResponse struct {
autorest.Response `json:"-"`
// Available - READ-ONLY; True if the name is available, otherwise false.
Available *bool `json:"available,omitempty"`
// Message - READ-ONLY; A message explaining why the name is unavailable. Will be null if the name is available.
Message *string `json:"message,omitempty"`
// Name - READ-ONLY; The name whose availability was checked.
Name *string `json:"name,omitempty"`
// Reason - READ-ONLY; The reason code explaining why the name is unavailable. Will be null if the name is available. Possible values include: 'Invalid', 'AlreadyExists'
Reason CheckNameAvailabilityReason `json:"reason,omitempty"`
}CheckNameAvailabilityResponse a response indicating whether the specified name for a resource is available.
CreateMode enumerates the values for create mode.
const (
// Copy ...
Copy CreateMode = "Copy"
// Default ...
Default CreateMode = "Default"
// NonReadableSecondary ...
NonReadableSecondary CreateMode = "NonReadableSecondary"
// OnlineSecondary ...
OnlineSecondary CreateMode = "OnlineSecondary"
// PointInTimeRestore ...
PointInTimeRestore CreateMode = "PointInTimeRestore"
// Recovery ...
Recovery CreateMode = "Recovery"
// Restore ...
Restore CreateMode = "Restore"
// RestoreLongTermRetentionBackup ...
RestoreLongTermRetentionBackup CreateMode = "RestoreLongTermRetentionBackup"
)func PossibleCreateModeValues() []CreateMode
PossibleCreateModeValues returns an array of possible values for the CreateMode const type.
DataMaskingFunction enumerates the values for data masking function.
const (
// DataMaskingFunctionCCN ...
DataMaskingFunctionCCN DataMaskingFunction = "CCN"
// DataMaskingFunctionDefault ...
DataMaskingFunctionDefault DataMaskingFunction = "Default"
// DataMaskingFunctionEmail ...
DataMaskingFunctionEmail DataMaskingFunction = "Email"
// DataMaskingFunctionNumber ...
DataMaskingFunctionNumber DataMaskingFunction = "Number"
// DataMaskingFunctionSSN ...
DataMaskingFunctionSSN DataMaskingFunction = "SSN"
// DataMaskingFunctionText ...
DataMaskingFunctionText DataMaskingFunction = "Text"
)func PossibleDataMaskingFunctionValues() []DataMaskingFunction
PossibleDataMaskingFunctionValues returns an array of possible values for the DataMaskingFunction const type.
type DataMaskingPoliciesClient struct {
BaseClient
}DataMaskingPoliciesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDataMaskingPoliciesClient(subscriptionID string) DataMaskingPoliciesClient
NewDataMaskingPoliciesClient creates an instance of the DataMaskingPoliciesClient client.
func NewDataMaskingPoliciesClientWithBaseURI(baseURI string, subscriptionID string) DataMaskingPoliciesClient
NewDataMaskingPoliciesClientWithBaseURI creates an instance of the DataMaskingPoliciesClient 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 DataMaskingPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DataMaskingPolicy) (result DataMaskingPolicy, err error)
CreateOrUpdate creates or updates a database data masking policy Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database. parameters - parameters for creating or updating a data masking policy.
func (client DataMaskingPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DataMaskingPolicy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DataMaskingPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result DataMaskingPolicy, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DataMaskingPoliciesClient) 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 DataMaskingPoliciesClient) Get(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DataMaskingPolicy, err error)
Get gets a database data masking policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DataMaskingPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DataMaskingPoliciesClient) GetResponder(resp *http.Response) (result DataMaskingPolicy, 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.
type DataMaskingPolicy struct {
autorest.Response `json:"-"`
// DataMaskingPolicyProperties - The properties of the data masking policy.
*DataMaskingPolicyProperties `json:"properties,omitempty"`
// Location - READ-ONLY; The location of the data masking policy.
Location *string `json:"location,omitempty"`
// Kind - READ-ONLY; The kind of data masking policy. Metadata, used for Azure portal.
Kind *string `json:"kind,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"`
}DataMaskingPolicy represents a database data masking policy.
func (dmp DataMaskingPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataMaskingPolicy.
func (dmp *DataMaskingPolicy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DataMaskingPolicy struct.
type DataMaskingPolicyProperties struct {
// DataMaskingState - The state of the data masking policy. Possible values include: 'DataMaskingStateDisabled', 'DataMaskingStateEnabled'
DataMaskingState DataMaskingState `json:"dataMaskingState,omitempty"`
// ExemptPrincipals - The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
ExemptPrincipals *string `json:"exemptPrincipals,omitempty"`
// ApplicationPrincipals - READ-ONLY; The list of the application principals. This is a legacy parameter and is no longer used.
ApplicationPrincipals *string `json:"applicationPrincipals,omitempty"`
// MaskingLevel - READ-ONLY; The masking level. This is a legacy parameter and is no longer used.
MaskingLevel *string `json:"maskingLevel,omitempty"`
}DataMaskingPolicyProperties the properties of a database data masking policy.
func (dmpp DataMaskingPolicyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataMaskingPolicyProperties.
type DataMaskingRule struct {
autorest.Response `json:"-"`
// DataMaskingRuleProperties - The properties of the resource.
*DataMaskingRuleProperties `json:"properties,omitempty"`
// Location - READ-ONLY; The location of the data masking rule.
Location *string `json:"location,omitempty"`
// Kind - READ-ONLY; The kind of Data Masking Rule. Metadata, used for Azure portal.
Kind *string `json:"kind,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"`
}DataMaskingRule represents a database data masking rule.
func (dmr DataMaskingRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataMaskingRule.
func (dmr *DataMaskingRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DataMaskingRule struct.
type DataMaskingRuleListResult struct {
autorest.Response `json:"-"`
// Value - The list of database data masking rules.
Value *[]DataMaskingRule `json:"value,omitempty"`
}DataMaskingRuleListResult the response to a list data masking rules request.
type DataMaskingRuleProperties struct {
// ID - READ-ONLY; The rule Id.
ID *string `json:"id,omitempty"`
// AliasName - The alias name. This is a legacy parameter and is no longer used.
AliasName *string `json:"aliasName,omitempty"`
// RuleState - The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: 'DataMaskingRuleStateDisabled', 'DataMaskingRuleStateEnabled'
RuleState DataMaskingRuleState `json:"ruleState,omitempty"`
// SchemaName - The schema name on which the data masking rule is applied.
SchemaName *string `json:"schemaName,omitempty"`
// TableName - The table name on which the data masking rule is applied.
TableName *string `json:"tableName,omitempty"`
// ColumnName - The column name on which the data masking rule is applied.
ColumnName *string `json:"columnName,omitempty"`
// MaskingFunction - The masking function that is used for the data masking rule. Possible values include: 'DataMaskingFunctionDefault', 'DataMaskingFunctionCCN', 'DataMaskingFunctionEmail', 'DataMaskingFunctionNumber', 'DataMaskingFunctionSSN', 'DataMaskingFunctionText'
MaskingFunction DataMaskingFunction `json:"maskingFunction,omitempty"`
// NumberFrom - The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
NumberFrom *string `json:"numberFrom,omitempty"`
// NumberTo - The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
NumberTo *string `json:"numberTo,omitempty"`
// PrefixSize - If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
PrefixSize *string `json:"prefixSize,omitempty"`
// SuffixSize - If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
SuffixSize *string `json:"suffixSize,omitempty"`
// ReplacementString - If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.
ReplacementString *string `json:"replacementString,omitempty"`
}DataMaskingRuleProperties the properties of a database data masking rule.
func (dmrp DataMaskingRuleProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DataMaskingRuleProperties.
DataMaskingRuleState enumerates the values for data masking rule state.
const (
// DataMaskingRuleStateDisabled ...
DataMaskingRuleStateDisabled DataMaskingRuleState = "Disabled"
// DataMaskingRuleStateEnabled ...
DataMaskingRuleStateEnabled DataMaskingRuleState = "Enabled"
)func PossibleDataMaskingRuleStateValues() []DataMaskingRuleState
PossibleDataMaskingRuleStateValues returns an array of possible values for the DataMaskingRuleState const type.
type DataMaskingRulesClient struct {
BaseClient
}DataMaskingRulesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDataMaskingRulesClient(subscriptionID string) DataMaskingRulesClient
NewDataMaskingRulesClient creates an instance of the DataMaskingRulesClient client.
func NewDataMaskingRulesClientWithBaseURI(baseURI string, subscriptionID string) DataMaskingRulesClient
NewDataMaskingRulesClientWithBaseURI creates an instance of the DataMaskingRulesClient 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 DataMaskingRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, dataMaskingRuleName string, parameters DataMaskingRule) (result DataMaskingRule, err error)
CreateOrUpdate creates or updates a database data masking rule. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database. dataMaskingRuleName - the name of the data masking rule. parameters - the required parameters for creating or updating a data masking rule.
func (client DataMaskingRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, dataMaskingRuleName string, parameters DataMaskingRule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DataMaskingRulesClient) CreateOrUpdateResponder(resp *http.Response) (result DataMaskingRule, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DataMaskingRulesClient) 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 DataMaskingRulesClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DataMaskingRuleListResult, err error)
ListByDatabase gets a list of database data masking rules. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DataMaskingRulesClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListByDatabasePreparer prepares the ListByDatabase request.
func (client DataMaskingRulesClient) ListByDatabaseResponder(resp *http.Response) (result DataMaskingRuleListResult, err error)
ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.
func (client DataMaskingRulesClient) ListByDatabaseSender(req *http.Request) (*http.Response, error)
ListByDatabaseSender sends the ListByDatabase request. The method will close the http.Response Body if it receives an error.
DataMaskingState enumerates the values for data masking state.
const (
// DataMaskingStateDisabled ...
DataMaskingStateDisabled DataMaskingState = "Disabled"
// DataMaskingStateEnabled ...
DataMaskingStateEnabled DataMaskingState = "Enabled"
)func PossibleDataMaskingStateValues() []DataMaskingState
PossibleDataMaskingStateValues returns an array of possible values for the DataMaskingState const type.
type Database struct {
autorest.Response `json:"-"`
// Kind - READ-ONLY; Kind of database. This is metadata used for the Azure portal experience.
Kind *string `json:"kind,omitempty"`
// DatabaseProperties - The properties representing the resource.
*DatabaseProperties `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"`
}Database represents a database.
MarshalJSON is the custom marshaler for Database.
UnmarshalJSON is the custom unmarshaler for Database struct.
type DatabaseBlobAuditingPoliciesClient struct {
BaseClient
}DatabaseBlobAuditingPoliciesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDatabaseBlobAuditingPoliciesClient(subscriptionID string) DatabaseBlobAuditingPoliciesClient
NewDatabaseBlobAuditingPoliciesClient creates an instance of the DatabaseBlobAuditingPoliciesClient client.
func NewDatabaseBlobAuditingPoliciesClientWithBaseURI(baseURI string, subscriptionID string) DatabaseBlobAuditingPoliciesClient
NewDatabaseBlobAuditingPoliciesClientWithBaseURI creates an instance of the DatabaseBlobAuditingPoliciesClient 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 DatabaseBlobAuditingPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseBlobAuditingPolicy) (result DatabaseBlobAuditingPolicy, err error)
CreateOrUpdate creates or updates a database's blob auditing policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database. parameters - the database blob auditing policy.
func (client DatabaseBlobAuditingPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseBlobAuditingPolicy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DatabaseBlobAuditingPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result DatabaseBlobAuditingPolicy, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DatabaseBlobAuditingPoliciesClient) 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 DatabaseBlobAuditingPoliciesClient) Get(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseBlobAuditingPolicy, err error)
Get gets a database's blob auditing policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DatabaseBlobAuditingPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DatabaseBlobAuditingPoliciesClient) GetResponder(resp *http.Response) (result DatabaseBlobAuditingPolicy, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DatabaseBlobAuditingPoliciesClient) 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 DatabaseBlobAuditingPoliciesClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseBlobAuditingPolicyListResultPage, err error)
ListByDatabase lists auditing settings of a database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DatabaseBlobAuditingPoliciesClient) ListByDatabaseComplete(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseBlobAuditingPolicyListResultIterator, err error)
ListByDatabaseComplete enumerates all values, automatically crossing page boundaries as required.
func (client DatabaseBlobAuditingPoliciesClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListByDatabasePreparer prepares the ListByDatabase request.
func (client DatabaseBlobAuditingPoliciesClient) ListByDatabaseResponder(resp *http.Response) (result DatabaseBlobAuditingPolicyListResult, err error)
ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.
func (client DatabaseBlobAuditingPoliciesClient) ListByDatabaseSender(req *http.Request) (*http.Response, error)
ListByDatabaseSender sends the ListByDatabase request. The method will close the http.Response Body if it receives an error.
type DatabaseBlobAuditingPolicy struct {
autorest.Response `json:"-"`
// Kind - READ-ONLY; Resource kind.
Kind *string `json:"kind,omitempty"`
// DatabaseBlobAuditingPolicyProperties - Resource properties.
*DatabaseBlobAuditingPolicyProperties `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"`
}DatabaseBlobAuditingPolicy a database blob auditing policy.
func (dbap DatabaseBlobAuditingPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseBlobAuditingPolicy.
func (dbap *DatabaseBlobAuditingPolicy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseBlobAuditingPolicy struct.
type DatabaseBlobAuditingPolicyListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]DatabaseBlobAuditingPolicy `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}DatabaseBlobAuditingPolicyListResult a list of database auditing settings.
func (dbaplr DatabaseBlobAuditingPolicyListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DatabaseBlobAuditingPolicyListResultIterator struct {
// contains filtered or unexported fields
}DatabaseBlobAuditingPolicyListResultIterator provides access to a complete listing of DatabaseBlobAuditingPolicy values.
func NewDatabaseBlobAuditingPolicyListResultIterator(page DatabaseBlobAuditingPolicyListResultPage) DatabaseBlobAuditingPolicyListResultIterator
Creates a new instance of the DatabaseBlobAuditingPolicyListResultIterator type.
func (iter *DatabaseBlobAuditingPolicyListResultIterator) 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 *DatabaseBlobAuditingPolicyListResultIterator) 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 DatabaseBlobAuditingPolicyListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DatabaseBlobAuditingPolicyListResultIterator) Response() DatabaseBlobAuditingPolicyListResult
Response returns the raw server response from the last page request.
func (iter DatabaseBlobAuditingPolicyListResultIterator) Value() DatabaseBlobAuditingPolicy
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DatabaseBlobAuditingPolicyListResultPage struct {
// contains filtered or unexported fields
}DatabaseBlobAuditingPolicyListResultPage contains a page of DatabaseBlobAuditingPolicy values.
func NewDatabaseBlobAuditingPolicyListResultPage(cur DatabaseBlobAuditingPolicyListResult, getNextPage func(context.Context, DatabaseBlobAuditingPolicyListResult) (DatabaseBlobAuditingPolicyListResult, error)) DatabaseBlobAuditingPolicyListResultPage
Creates a new instance of the DatabaseBlobAuditingPolicyListResultPage type.
func (page *DatabaseBlobAuditingPolicyListResultPage) 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 *DatabaseBlobAuditingPolicyListResultPage) 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 DatabaseBlobAuditingPolicyListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DatabaseBlobAuditingPolicyListResultPage) Response() DatabaseBlobAuditingPolicyListResult
Response returns the raw server response from the last page request.
func (page DatabaseBlobAuditingPolicyListResultPage) Values() []DatabaseBlobAuditingPolicy
Values returns the slice of values for the current page or nil if there are no values.
type DatabaseBlobAuditingPolicyProperties struct {
// State - Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'
State BlobAuditingPolicyState `json:"state,omitempty"`
// StorageEndpoint - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
StorageEndpoint *string `json:"storageEndpoint,omitempty"`
// StorageAccountAccessKey - Specifies the identifier key of the auditing storage account.
// If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.
// Prerequisites for using managed identity authentication:
// 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
// 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.
// For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)
StorageAccountAccessKey *string `json:"storageAccountAccessKey,omitempty"`
// RetentionDays - Specifies the number of days to keep in the audit logs in the storage account.
RetentionDays *int32 `json:"retentionDays,omitempty"`
// AuditActionsAndGroups - Specifies the Actions-Groups and Actions to audit.
//
// The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:
//
// BATCH_COMPLETED_GROUP,
// SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
// FAILED_DATABASE_AUTHENTICATION_GROUP.
//
// This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
//
// The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):
//
// APPLICATION_ROLE_CHANGE_PASSWORD_GROUP
// BACKUP_RESTORE_GROUP
// DATABASE_LOGOUT_GROUP
// DATABASE_OBJECT_CHANGE_GROUP
// DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP
// DATABASE_OBJECT_PERMISSION_CHANGE_GROUP
// DATABASE_OPERATION_GROUP
// DATABASE_PERMISSION_CHANGE_GROUP
// DATABASE_PRINCIPAL_CHANGE_GROUP
// DATABASE_PRINCIPAL_IMPERSONATION_GROUP
// DATABASE_ROLE_MEMBER_CHANGE_GROUP
// FAILED_DATABASE_AUTHENTICATION_GROUP
// SCHEMA_OBJECT_ACCESS_GROUP
// SCHEMA_OBJECT_CHANGE_GROUP
// SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP
// SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP
// SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP
// USER_CHANGE_PASSWORD_GROUP
// BATCH_STARTED_GROUP
// BATCH_COMPLETED_GROUP
//
// These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.
//
// For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).
//
// For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:
// SELECT
// UPDATE
// INSERT
// DELETE
// EXECUTE
// RECEIVE
// REFERENCES
//
// The general form for defining an action to be audited is:
// {action} ON {object} BY {principal}
//
// Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.
//
// For example:
// SELECT on dbo.myTable by public
// SELECT on DATABASE::myDatabase by public
// SELECT on SCHEMA::mySchema by public
//
// For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)
AuditActionsAndGroups *[]string `json:"auditActionsAndGroups,omitempty"`
// StorageAccountSubscriptionID - Specifies the blob storage subscription Id.
StorageAccountSubscriptionID *uuid.UUID `json:"storageAccountSubscriptionId,omitempty"`
// IsStorageSecondaryKeyInUse - Specifies whether storageAccountAccessKey value is the storage's secondary key.
IsStorageSecondaryKeyInUse *bool `json:"isStorageSecondaryKeyInUse,omitempty"`
// IsAzureMonitorTargetEnabled - Specifies whether audit events are sent to Azure Monitor.
// In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
//
// When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.
// Note that for server level audit you should use the 'master' database as {databaseName}.
//
// Diagnostic Settings URI format:
// PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
//
// For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)
// or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)
IsAzureMonitorTargetEnabled *bool `json:"isAzureMonitorTargetEnabled,omitempty"`
// QueueDelayMs - Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.
// The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.
QueueDelayMs *int32 `json:"queueDelayMs,omitempty"`
}DatabaseBlobAuditingPolicyProperties properties of a database blob auditing policy.
DatabaseEdition enumerates the values for database edition.
const (
// Basic ...
Basic DatabaseEdition = "Basic"
// Business ...
Business DatabaseEdition = "Business"
// BusinessCritical ...
BusinessCritical DatabaseEdition = "BusinessCritical"
// DataWarehouse ...
DataWarehouse DatabaseEdition = "DataWarehouse"
// Free ...
Free DatabaseEdition = "Free"
// GeneralPurpose ...
GeneralPurpose DatabaseEdition = "GeneralPurpose"
// Hyperscale ...
Hyperscale DatabaseEdition = "Hyperscale"
// Premium ...
Premium DatabaseEdition = "Premium"
// PremiumRS ...
PremiumRS DatabaseEdition = "PremiumRS"
// Standard ...
Standard DatabaseEdition = "Standard"
// Stretch ...
Stretch DatabaseEdition = "Stretch"
// System ...
System DatabaseEdition = "System"
// System2 ...
System2 DatabaseEdition = "System2"
// Web ...
Web DatabaseEdition = "Web"
)func PossibleDatabaseEditionValues() []DatabaseEdition
PossibleDatabaseEditionValues returns an array of possible values for the DatabaseEdition const type.
type DatabaseListResult struct {
autorest.Response `json:"-"`
// Value - The list of databases housed in the server.
Value *[]Database `json:"value,omitempty"`
}DatabaseListResult represents the response to a list database request.
type DatabaseProperties struct {
// Collation - The collation of the database. If createMode is not Default, this value is ignored.
Collation *string `json:"collation,omitempty"`
// CreationDate - READ-ONLY; The creation date of the database (ISO8601 format).
CreationDate *date.Time `json:"creationDate,omitempty"`
// ContainmentState - READ-ONLY; The containment state of the database.
ContainmentState *int64 `json:"containmentState,omitempty"`
// CurrentServiceObjectiveID - READ-ONLY; The current service level objective ID of the database. This is the ID of the service level objective that is currently active.
CurrentServiceObjectiveID *uuid.UUID `json:"currentServiceObjectiveId,omitempty"`
// DatabaseID - READ-ONLY; The ID of the database.
DatabaseID *uuid.UUID `json:"databaseId,omitempty"`
// EarliestRestoreDate - READ-ONLY; This records the earliest start date and time that restore is available for this database (ISO8601 format).
EarliestRestoreDate *date.Time `json:"earliestRestoreDate,omitempty"`
// CreateMode - Specifies the mode of database creation.
// Default: regular database creation.
// Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.
// OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.
// PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.
// Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.
// Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.
// RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.
// Copy, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Copy', 'Default', 'NonReadableSecondary', 'OnlineSecondary', 'PointInTimeRestore', 'Recovery', 'Restore', 'RestoreLongTermRetentionBackup'
CreateMode CreateMode `json:"createMode,omitempty"`
// SourceDatabaseID - Conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.
SourceDatabaseID *string `json:"sourceDatabaseId,omitempty"`
// SourceDatabaseDeletionDate - Conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.
SourceDatabaseDeletionDate *date.Time `json:"sourceDatabaseDeletionDate,omitempty"`
// RestorePointInTime - Conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.
RestorePointInTime *date.Time `json:"restorePointInTime,omitempty"`
// RecoveryServicesRecoveryPointResourceID - Conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.
RecoveryServicesRecoveryPointResourceID *string `json:"recoveryServicesRecoveryPointResourceId,omitempty"`
// Edition - The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.
//
// The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:
//
// ```azurecli
// az sql db list-editions -l <location> -o table
// ````
//
// ```powershell
// Get-AzSqlServerServiceObjective -Location <location>
// ````
// . Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'
Edition DatabaseEdition `json:"edition,omitempty"`
// MaxSizeBytes - The max size of the database expressed in bytes. If createMode is not Default, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation."
MaxSizeBytes *string `json:"maxSizeBytes,omitempty"`
// RequestedServiceObjectiveID - The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName.
//
// The list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API.
RequestedServiceObjectiveID *uuid.UUID `json:"requestedServiceObjectiveId,omitempty"`
// RequestedServiceObjectiveName - The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property.
//
// The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:
//
// ```azurecli
// az sql db list-editions -l <location> -o table
// ````
//
// ```powershell
// Get-AzSqlServerServiceObjective -Location <location>
// ````
// . Possible values include: 'ServiceObjectiveNameSystem', 'ServiceObjectiveNameSystem0', 'ServiceObjectiveNameSystem1', 'ServiceObjectiveNameSystem2', 'ServiceObjectiveNameSystem3', 'ServiceObjectiveNameSystem4', 'ServiceObjectiveNameSystem2L', 'ServiceObjectiveNameSystem3L', 'ServiceObjectiveNameSystem4L', 'ServiceObjectiveNameFree', 'ServiceObjectiveNameBasic', 'ServiceObjectiveNameS0', 'ServiceObjectiveNameS1', 'ServiceObjectiveNameS2', 'ServiceObjectiveNameS3', 'ServiceObjectiveNameS4', 'ServiceObjectiveNameS6', 'ServiceObjectiveNameS7', 'ServiceObjectiveNameS9', 'ServiceObjectiveNameS12', 'ServiceObjectiveNameP1', 'ServiceObjectiveNameP2', 'ServiceObjectiveNameP3', 'ServiceObjectiveNameP4', 'ServiceObjectiveNameP6', 'ServiceObjectiveNameP11', 'ServiceObjectiveNameP15', 'ServiceObjectiveNamePRS1', 'ServiceObjectiveNamePRS2', 'ServiceObjectiveNamePRS4', 'ServiceObjectiveNamePRS6', 'ServiceObjectiveNameDW100', 'ServiceObjectiveNameDW200', 'ServiceObjectiveNameDW300', 'ServiceObjectiveNameDW400', 'ServiceObjectiveNameDW500', 'ServiceObjectiveNameDW600', 'ServiceObjectiveNameDW1000', 'ServiceObjectiveNameDW1200', 'ServiceObjectiveNameDW1000c', 'ServiceObjectiveNameDW1500', 'ServiceObjectiveNameDW1500c', 'ServiceObjectiveNameDW2000', 'ServiceObjectiveNameDW2000c', 'ServiceObjectiveNameDW3000', 'ServiceObjectiveNameDW2500c', 'ServiceObjectiveNameDW3000c', 'ServiceObjectiveNameDW6000', 'ServiceObjectiveNameDW5000c', 'ServiceObjectiveNameDW6000c', 'ServiceObjectiveNameDW7500c', 'ServiceObjectiveNameDW10000c', 'ServiceObjectiveNameDW15000c', 'ServiceObjectiveNameDW30000c', 'ServiceObjectiveNameDS100', 'ServiceObjectiveNameDS200', 'ServiceObjectiveNameDS300', 'ServiceObjectiveNameDS400', 'ServiceObjectiveNameDS500', 'ServiceObjectiveNameDS600', 'ServiceObjectiveNameDS1000', 'ServiceObjectiveNameDS1200', 'ServiceObjectiveNameDS1500', 'ServiceObjectiveNameDS2000', 'ServiceObjectiveNameElasticPool'
RequestedServiceObjectiveName ServiceObjectiveName `json:"requestedServiceObjectiveName,omitempty"`
// ServiceLevelObjective - READ-ONLY; The current service level objective of the database. Possible values include: 'ServiceObjectiveNameSystem', 'ServiceObjectiveNameSystem0', 'ServiceObjectiveNameSystem1', 'ServiceObjectiveNameSystem2', 'ServiceObjectiveNameSystem3', 'ServiceObjectiveNameSystem4', 'ServiceObjectiveNameSystem2L', 'ServiceObjectiveNameSystem3L', 'ServiceObjectiveNameSystem4L', 'ServiceObjectiveNameFree', 'ServiceObjectiveNameBasic', 'ServiceObjectiveNameS0', 'ServiceObjectiveNameS1', 'ServiceObjectiveNameS2', 'ServiceObjectiveNameS3', 'ServiceObjectiveNameS4', 'ServiceObjectiveNameS6', 'ServiceObjectiveNameS7', 'ServiceObjectiveNameS9', 'ServiceObjectiveNameS12', 'ServiceObjectiveNameP1', 'ServiceObjectiveNameP2', 'ServiceObjectiveNameP3', 'ServiceObjectiveNameP4', 'ServiceObjectiveNameP6', 'ServiceObjectiveNameP11', 'ServiceObjectiveNameP15', 'ServiceObjectiveNamePRS1', 'ServiceObjectiveNamePRS2', 'ServiceObjectiveNamePRS4', 'ServiceObjectiveNamePRS6', 'ServiceObjectiveNameDW100', 'ServiceObjectiveNameDW200', 'ServiceObjectiveNameDW300', 'ServiceObjectiveNameDW400', 'ServiceObjectiveNameDW500', 'ServiceObjectiveNameDW600', 'ServiceObjectiveNameDW1000', 'ServiceObjectiveNameDW1200', 'ServiceObjectiveNameDW1000c', 'ServiceObjectiveNameDW1500', 'ServiceObjectiveNameDW1500c', 'ServiceObjectiveNameDW2000', 'ServiceObjectiveNameDW2000c', 'ServiceObjectiveNameDW3000', 'ServiceObjectiveNameDW2500c', 'ServiceObjectiveNameDW3000c', 'ServiceObjectiveNameDW6000', 'ServiceObjectiveNameDW5000c', 'ServiceObjectiveNameDW6000c', 'ServiceObjectiveNameDW7500c', 'ServiceObjectiveNameDW10000c', 'ServiceObjectiveNameDW15000c', 'ServiceObjectiveNameDW30000c', 'ServiceObjectiveNameDS100', 'ServiceObjectiveNameDS200', 'ServiceObjectiveNameDS300', 'ServiceObjectiveNameDS400', 'ServiceObjectiveNameDS500', 'ServiceObjectiveNameDS600', 'ServiceObjectiveNameDS1000', 'ServiceObjectiveNameDS1200', 'ServiceObjectiveNameDS1500', 'ServiceObjectiveNameDS2000', 'ServiceObjectiveNameElasticPool'
ServiceLevelObjective ServiceObjectiveName `json:"serviceLevelObjective,omitempty"`
// Status - READ-ONLY; The status of the database.
Status *string `json:"status,omitempty"`
// ElasticPoolName - The name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.
ElasticPoolName *string `json:"elasticPoolName,omitempty"`
// DefaultSecondaryLocation - READ-ONLY; The default secondary region for this database.
DefaultSecondaryLocation *string `json:"defaultSecondaryLocation,omitempty"`
// ServiceTierAdvisors - READ-ONLY; The list of service tier advisors for this database. Expanded property
ServiceTierAdvisors *[]ServiceTierAdvisor `json:"serviceTierAdvisors,omitempty"`
// TransparentDataEncryption - READ-ONLY; The transparent data encryption info for this database.
TransparentDataEncryption *[]TransparentDataEncryption `json:"transparentDataEncryption,omitempty"`
// RecommendedIndex - READ-ONLY; The recommended indices for this database.
RecommendedIndex *[]RecommendedIndex `json:"recommendedIndex,omitempty"`
// FailoverGroupID - READ-ONLY; The resource identifier of the failover group containing this database.
FailoverGroupID *string `json:"failoverGroupId,omitempty"`
// ReadScale - Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition. Possible values include: 'ReadScaleEnabled', 'ReadScaleDisabled'
ReadScale ReadScale `json:"readScale,omitempty"`
// SampleName - Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition. Possible values include: 'AdventureWorksLT'
SampleName SampleName `json:"sampleName,omitempty"`
// ZoneRedundant - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
ZoneRedundant *bool `json:"zoneRedundant,omitempty"`
}DatabaseProperties represents the properties of a database.
func (dp DatabaseProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseProperties.
type DatabaseSecurityAlertPolicy struct {
autorest.Response `json:"-"`
// Location - The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// Kind - READ-ONLY; Resource kind.
Kind *string `json:"kind,omitempty"`
// DatabaseSecurityAlertPolicyProperties - Properties of the security alert policy.
*DatabaseSecurityAlertPolicyProperties `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"`
}DatabaseSecurityAlertPolicy contains information about a database Threat Detection policy.
func (dsap DatabaseSecurityAlertPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseSecurityAlertPolicy.
func (dsap *DatabaseSecurityAlertPolicy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseSecurityAlertPolicy struct.
type DatabaseSecurityAlertPolicyProperties struct {
// State - Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. Possible values include: 'SecurityAlertPolicyStateNew', 'SecurityAlertPolicyStateEnabled', 'SecurityAlertPolicyStateDisabled'
State SecurityAlertPolicyState `json:"state,omitempty"`
// DisabledAlerts - Specifies the semicolon-separated list of alerts that are disabled, or empty string to disable no alerts. Possible values: Sql_Injection; Sql_Injection_Vulnerability; Access_Anomaly; Data_Exfiltration; Unsafe_Action.
DisabledAlerts *string `json:"disabledAlerts,omitempty"`
// EmailAddresses - Specifies the semicolon-separated list of e-mail addresses to which the alert is sent.
EmailAddresses *string `json:"emailAddresses,omitempty"`
// EmailAccountAdmins - Specifies that the alert is sent to the account administrators. Possible values include: 'SecurityAlertPolicyEmailAccountAdminsEnabled', 'SecurityAlertPolicyEmailAccountAdminsDisabled'
EmailAccountAdmins SecurityAlertPolicyEmailAccountAdmins `json:"emailAccountAdmins,omitempty"`
// StorageEndpoint - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. If state is Enabled, storageEndpoint is required.
StorageEndpoint *string `json:"storageEndpoint,omitempty"`
// StorageAccountAccessKey - Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required.
StorageAccountAccessKey *string `json:"storageAccountAccessKey,omitempty"`
// RetentionDays - Specifies the number of days to keep in the Threat Detection audit logs.
RetentionDays *int32 `json:"retentionDays,omitempty"`
// UseServerDefault - Specifies whether to use the default server policy. Possible values include: 'SecurityAlertPolicyUseServerDefaultEnabled', 'SecurityAlertPolicyUseServerDefaultDisabled'
UseServerDefault SecurityAlertPolicyUseServerDefault `json:"useServerDefault,omitempty"`
}DatabaseSecurityAlertPolicyProperties properties for a database Threat Detection policy.
type DatabaseThreatDetectionPoliciesClient struct {
BaseClient
}DatabaseThreatDetectionPoliciesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDatabaseThreatDetectionPoliciesClient(subscriptionID string) DatabaseThreatDetectionPoliciesClient
NewDatabaseThreatDetectionPoliciesClient creates an instance of the DatabaseThreatDetectionPoliciesClient client.
func NewDatabaseThreatDetectionPoliciesClientWithBaseURI(baseURI string, subscriptionID string) DatabaseThreatDetectionPoliciesClient
NewDatabaseThreatDetectionPoliciesClientWithBaseURI creates an instance of the DatabaseThreatDetectionPoliciesClient 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 DatabaseThreatDetectionPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseSecurityAlertPolicy) (result DatabaseSecurityAlertPolicy, err error)
CreateOrUpdate creates or updates a database's threat detection policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database for which database Threat Detection policy is defined. parameters - the database Threat Detection policy.
func (client DatabaseThreatDetectionPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseSecurityAlertPolicy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DatabaseThreatDetectionPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result DatabaseSecurityAlertPolicy, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DatabaseThreatDetectionPoliciesClient) 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 DatabaseThreatDetectionPoliciesClient) Get(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseSecurityAlertPolicy, err error)
Get gets a database's threat detection policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database for which database Threat Detection policy is defined.
func (client DatabaseThreatDetectionPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DatabaseThreatDetectionPoliciesClient) GetResponder(resp *http.Response) (result DatabaseSecurityAlertPolicy, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DatabaseThreatDetectionPoliciesClient) 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.
type DatabaseUpdate struct {
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// DatabaseProperties - The properties representing the resource.
*DatabaseProperties `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"`
}DatabaseUpdate represents a database update.
func (du DatabaseUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseUpdate.
func (du *DatabaseUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseUpdate struct.
type DatabaseUsage struct {
// Name - READ-ONLY; The name of the usage metric.
Name *string `json:"name,omitempty"`
// ResourceName - READ-ONLY; The name of the resource.
ResourceName *string `json:"resourceName,omitempty"`
// DisplayName - READ-ONLY; The usage metric display name.
DisplayName *string `json:"displayName,omitempty"`
// CurrentValue - READ-ONLY; The current value of the usage metric.
CurrentValue *float64 `json:"currentValue,omitempty"`
// Limit - READ-ONLY; The current limit of the usage metric.
Limit *float64 `json:"limit,omitempty"`
// Unit - READ-ONLY; The units of the usage metric.
Unit *string `json:"unit,omitempty"`
// NextResetTime - READ-ONLY; The next reset time for the usage metric (ISO8601 format).
NextResetTime *date.Time `json:"nextResetTime,omitempty"`
}DatabaseUsage the database usages.
type DatabaseUsageListResult struct {
autorest.Response `json:"-"`
// Value - The list of database usages for the database.
Value *[]DatabaseUsage `json:"value,omitempty"`
}DatabaseUsageListResult the response to a list database metrics request.
type DatabaseUsagesClient struct {
BaseClient
}DatabaseUsagesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDatabaseUsagesClient(subscriptionID string) DatabaseUsagesClient
NewDatabaseUsagesClient creates an instance of the DatabaseUsagesClient client.
func NewDatabaseUsagesClientWithBaseURI(baseURI string, subscriptionID string) DatabaseUsagesClient
NewDatabaseUsagesClientWithBaseURI creates an instance of the DatabaseUsagesClient 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 DatabaseUsagesClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseUsageListResult, err error)
ListByDatabase returns database usages. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DatabaseUsagesClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListByDatabasePreparer prepares the ListByDatabase request.
func (client DatabaseUsagesClient) ListByDatabaseResponder(resp *http.Response) (result DatabaseUsageListResult, err error)
ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.
ListByDatabaseSender sends the ListByDatabase request. The method will close the http.Response Body if it receives an error.
type DatabasesClient struct {
BaseClient
}DatabasesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewDatabasesClient(subscriptionID string) DatabasesClient
NewDatabasesClient creates an instance of the DatabasesClient client.
func NewDatabasesClientWithBaseURI(baseURI string, subscriptionID string) DatabasesClient
NewDatabasesClientWithBaseURI creates an instance of the DatabasesClient 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 DatabasesClient) CreateImportOperation(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters ImportExtensionRequest) (result DatabasesCreateImportOperationFuture, err error)
CreateImportOperation creates an import operation that imports a bacpac into an existing database. The existing database must be empty. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to import into parameters - the required parameters for importing a Bacpac into a database.
func (client DatabasesClient) CreateImportOperationPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters ImportExtensionRequest) (*http.Request, error)
CreateImportOperationPreparer prepares the CreateImportOperation request.
func (client DatabasesClient) CreateImportOperationResponder(resp *http.Response) (result ImportExportResponse, err error)
CreateImportOperationResponder handles the response to the CreateImportOperation request. The method always closes the http.Response Body.
func (client DatabasesClient) CreateImportOperationSender(req *http.Request) (future DatabasesCreateImportOperationFuture, err error)
CreateImportOperationSender sends the CreateImportOperation request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters Database) (result DatabasesCreateOrUpdateFuture, err error)
CreateOrUpdate creates a new database or updates an existing database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to be operated on (updated or created). parameters - the required parameters for creating or updating a database.
func (client DatabasesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters Database) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DatabasesClient) CreateOrUpdateResponder(resp *http.Response) (result Database, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DatabasesClient) CreateOrUpdateSender(req *http.Request) (future DatabasesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Delete(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result autorest.Response, err error)
Delete deletes a database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to be deleted.
func (client DatabasesClient) DeletePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DatabasesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Export(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters ExportRequest) (result DatabasesExportFuture, err error)
Export exports a database to a bacpac. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to be exported. parameters - the required parameters for exporting a database.
func (client DatabasesClient) ExportPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters ExportRequest) (*http.Request, error)
ExportPreparer prepares the Export request.
func (client DatabasesClient) ExportResponder(resp *http.Response) (result ImportExportResponse, err error)
ExportResponder handles the response to the Export request. The method always closes the http.Response Body.
func (client DatabasesClient) ExportSender(req *http.Request) (future DatabasesExportFuture, err error)
ExportSender sends the Export request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Get(ctx context.Context, resourceGroupName string, serverName string, databaseName string, expand string) (result Database, err error)
Get gets a database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to be retrieved. expand - a comma separated list of child objects to expand in the response. Possible properties: serviceTierAdvisors, transparentDataEncryption.
func (client DatabasesClient) GetByElasticPool(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, databaseName string) (result Database, err error)
GetByElasticPool gets a database inside of an elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be retrieved. databaseName - the name of the database to be retrieved.
func (client DatabasesClient) GetByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, databaseName string) (*http.Request, error)
GetByElasticPoolPreparer prepares the GetByElasticPool request.
func (client DatabasesClient) GetByElasticPoolResponder(resp *http.Response) (result Database, err error)
GetByElasticPoolResponder handles the response to the GetByElasticPool request. The method always closes the http.Response Body.
GetByElasticPoolSender sends the GetByElasticPool request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) GetByRecommendedElasticPool(ctx context.Context, resourceGroupName string, serverName string, recommendedElasticPoolName string, databaseName string) (result Database, err error)
GetByRecommendedElasticPool gets a database inside of a recommended elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. recommendedElasticPoolName - the name of the elastic pool to be retrieved. databaseName - the name of the database to be retrieved.
func (client DatabasesClient) GetByRecommendedElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, recommendedElasticPoolName string, databaseName string) (*http.Request, error)
GetByRecommendedElasticPoolPreparer prepares the GetByRecommendedElasticPool request.
func (client DatabasesClient) GetByRecommendedElasticPoolResponder(resp *http.Response) (result Database, err error)
GetByRecommendedElasticPoolResponder handles the response to the GetByRecommendedElasticPool request. The method always closes the http.Response Body.
func (client DatabasesClient) GetByRecommendedElasticPoolSender(req *http.Request) (*http.Response, error)
GetByRecommendedElasticPoolSender sends the GetByRecommendedElasticPool request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Import(ctx context.Context, resourceGroupName string, serverName string, parameters ImportRequest) (result DatabasesImportFuture, err error)
Import imports a bacpac into a new database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. parameters - the required parameters for importing a Bacpac into a database.
func (client DatabasesClient) ImportPreparer(ctx context.Context, resourceGroupName string, serverName string, parameters ImportRequest) (*http.Request, error)
ImportPreparer prepares the Import request.
func (client DatabasesClient) ImportResponder(resp *http.Response) (result ImportExportResponse, err error)
ImportResponder handles the response to the Import request. The method always closes the http.Response Body.
func (client DatabasesClient) ImportSender(req *http.Request) (future DatabasesImportFuture, err error)
ImportSender sends the Import request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) ListByElasticPool(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result DatabaseListResult, err error)
ListByElasticPool returns a list of databases in an elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be retrieved.
func (client DatabasesClient) ListByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
ListByElasticPoolPreparer prepares the ListByElasticPool request.
func (client DatabasesClient) ListByElasticPoolResponder(resp *http.Response) (result DatabaseListResult, err error)
ListByElasticPoolResponder handles the response to the ListByElasticPool request. The method always closes the http.Response Body.
ListByElasticPoolSender sends the ListByElasticPool request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) ListByRecommendedElasticPool(ctx context.Context, resourceGroupName string, serverName string, recommendedElasticPoolName string) (result DatabaseListResult, err error)
ListByRecommendedElasticPool returns a list of databases inside a recommended elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. recommendedElasticPoolName - the name of the recommended elastic pool to be retrieved.
func (client DatabasesClient) ListByRecommendedElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, recommendedElasticPoolName string) (*http.Request, error)
ListByRecommendedElasticPoolPreparer prepares the ListByRecommendedElasticPool request.
func (client DatabasesClient) ListByRecommendedElasticPoolResponder(resp *http.Response) (result DatabaseListResult, err error)
ListByRecommendedElasticPoolResponder handles the response to the ListByRecommendedElasticPool request. The method always closes the http.Response Body.
func (client DatabasesClient) ListByRecommendedElasticPoolSender(req *http.Request) (*http.Response, error)
ListByRecommendedElasticPoolSender sends the ListByRecommendedElasticPool request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) ListByServer(ctx context.Context, resourceGroupName string, serverName string, expand string, filter string) (result DatabaseListResult, err error)
ListByServer returns a list of databases in a server. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. expand - a comma separated list of child objects to expand in the response. Possible properties: serviceTierAdvisors, transparentDataEncryption. filter - an OData filter expression that describes a subset of databases to return.
func (client DatabasesClient) ListByServerPreparer(ctx context.Context, resourceGroupName string, serverName string, expand string, filter string) (*http.Request, error)
ListByServerPreparer prepares the ListByServer request.
func (client DatabasesClient) ListByServerResponder(resp *http.Response) (result DatabaseListResult, err error)
ListByServerResponder handles the response to the ListByServer request. The method always closes the http.Response Body.
ListByServerSender sends the ListByServer request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result MetricDefinitionListResult, err error)
ListMetricDefinitions returns database metric definitions. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client DatabasesClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client DatabasesClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client DatabasesClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) ListMetrics(ctx context.Context, resourceGroupName string, serverName string, databaseName string, filter string) (result MetricListResult, err error)
ListMetrics returns database metrics. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database. filter - an OData filter expression that describes a subset of metrics to return.
func (client DatabasesClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabasesClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Pause(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabasesPauseFuture, err error)
Pause pauses a data warehouse. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the data warehouse to pause.
func (client DatabasesClient) PausePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
PausePreparer prepares the Pause request.
func (client DatabasesClient) PauseResponder(resp *http.Response) (result autorest.Response, err error)
PauseResponder handles the response to the Pause request. The method always closes the http.Response Body.
func (client DatabasesClient) PauseSender(req *http.Request) (future DatabasesPauseFuture, err error)
PauseSender sends the Pause request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Resume(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabasesResumeFuture, err error)
Resume resumes a data warehouse. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the data warehouse to resume.
func (client DatabasesClient) ResumePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ResumePreparer prepares the Resume request.
func (client DatabasesClient) ResumeResponder(resp *http.Response) (result autorest.Response, err error)
ResumeResponder handles the response to the Resume request. The method always closes the http.Response Body.
func (client DatabasesClient) ResumeSender(req *http.Request) (future DatabasesResumeFuture, err error)
ResumeSender sends the Resume request. The method will close the http.Response Body if it receives an error.
func (client DatabasesClient) Update(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseUpdate) (result DatabasesUpdateFuture, err error)
Update updates an existing database. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database to be updated. parameters - the required parameters for updating a database.
func (client DatabasesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters DatabaseUpdate) (*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 DatabasesClient) UpdateSender(req *http.Request) (future DatabasesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DatabasesCreateImportOperationFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (ImportExportResponse, error)
}DatabasesCreateImportOperationFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (Database, error)
}DatabasesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesExportFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (ImportExportResponse, error)
}DatabasesExportFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesImportFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (ImportExportResponse, error)
}DatabasesImportFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesPauseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (autorest.Response, error)
}DatabasesPauseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesResumeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (autorest.Response, error)
}DatabasesResumeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabasesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabasesClient) (Database, error)
}DatabasesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EditionCapability struct {
// Name - READ-ONLY; The database edition name.
Name *string `json:"name,omitempty"`
// SupportedServiceLevelObjectives - READ-ONLY; The list of supported service objectives for the edition.
SupportedServiceLevelObjectives *[]ServiceLevelObjectiveCapability `json:"supportedServiceLevelObjectives,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}EditionCapability the edition capability.
func (ec EditionCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EditionCapability.
type ElasticPool struct {
autorest.Response `json:"-"`
// ElasticPoolProperties - The properties representing the resource.
*ElasticPoolProperties `json:"properties,omitempty"`
// Kind - READ-ONLY; Kind of elastic pool. This is metadata used for the Azure portal experience.
Kind *string `json:"kind,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"`
}ElasticPool represents a database elastic pool.
func (ep ElasticPool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPool.
func (ep *ElasticPool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ElasticPool struct.
type ElasticPoolActivitiesClient struct {
BaseClient
}ElasticPoolActivitiesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewElasticPoolActivitiesClient(subscriptionID string) ElasticPoolActivitiesClient
NewElasticPoolActivitiesClient creates an instance of the ElasticPoolActivitiesClient client.
func NewElasticPoolActivitiesClientWithBaseURI(baseURI string, subscriptionID string) ElasticPoolActivitiesClient
NewElasticPoolActivitiesClientWithBaseURI creates an instance of the ElasticPoolActivitiesClient 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 ElasticPoolActivitiesClient) ListByElasticPool(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result ElasticPoolActivityListResult, err error)
ListByElasticPool returns elastic pool activities. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool for which to get the current activity.
func (client ElasticPoolActivitiesClient) ListByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
ListByElasticPoolPreparer prepares the ListByElasticPool request.
func (client ElasticPoolActivitiesClient) ListByElasticPoolResponder(resp *http.Response) (result ElasticPoolActivityListResult, err error)
ListByElasticPoolResponder handles the response to the ListByElasticPool request. The method always closes the http.Response Body.
func (client ElasticPoolActivitiesClient) ListByElasticPoolSender(req *http.Request) (*http.Response, error)
ListByElasticPoolSender sends the ListByElasticPool request. The method will close the http.Response Body if it receives an error.
type ElasticPoolActivity struct {
// Location - The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// ElasticPoolActivityProperties - The properties representing the resource.
*ElasticPoolActivityProperties `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"`
}ElasticPoolActivity represents the activity on an elastic pool.
func (epa ElasticPoolActivity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolActivity.
func (epa *ElasticPoolActivity) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ElasticPoolActivity struct.
type ElasticPoolActivityListResult struct {
autorest.Response `json:"-"`
// Value - The list of elastic pool activities.
Value *[]ElasticPoolActivity `json:"value,omitempty"`
}ElasticPoolActivityListResult represents the response to a list elastic pool activity request.
type ElasticPoolActivityProperties struct {
// EndTime - READ-ONLY; The time the operation finished (ISO8601 format).
EndTime *date.Time `json:"endTime,omitempty"`
// ErrorCode - READ-ONLY; The error code if available.
ErrorCode *int32 `json:"errorCode,omitempty"`
// ErrorMessage - READ-ONLY; The error message if available.
ErrorMessage *string `json:"errorMessage,omitempty"`
// ErrorSeverity - READ-ONLY; The error severity if available.
ErrorSeverity *int32 `json:"errorSeverity,omitempty"`
// Operation - READ-ONLY; The operation name.
Operation *string `json:"operation,omitempty"`
// OperationID - READ-ONLY; The unique operation ID.
OperationID *uuid.UUID `json:"operationId,omitempty"`
// PercentComplete - READ-ONLY; The percentage complete if available.
PercentComplete *int32 `json:"percentComplete,omitempty"`
// RequestedDatabaseDtuMax - READ-ONLY; The requested max DTU per database if available.
RequestedDatabaseDtuMax *int32 `json:"requestedDatabaseDtuMax,omitempty"`
// RequestedDatabaseDtuMin - READ-ONLY; The requested min DTU per database if available.
RequestedDatabaseDtuMin *int32 `json:"requestedDatabaseDtuMin,omitempty"`
// RequestedDtu - READ-ONLY; The requested DTU for the pool if available.
RequestedDtu *int32 `json:"requestedDtu,omitempty"`
// RequestedElasticPoolName - READ-ONLY; The requested name for the elastic pool if available.
RequestedElasticPoolName *string `json:"requestedElasticPoolName,omitempty"`
// RequestedStorageLimitInGB - READ-ONLY; The requested storage limit for the pool in GB if available.
RequestedStorageLimitInGB *int64 `json:"requestedStorageLimitInGB,omitempty"`
// ElasticPoolName - READ-ONLY; The name of the elastic pool.
ElasticPoolName *string `json:"elasticPoolName,omitempty"`
// ServerName - READ-ONLY; The name of the server the elastic pool is in.
ServerName *string `json:"serverName,omitempty"`
// StartTime - READ-ONLY; The time the operation started (ISO8601 format).
StartTime *date.Time `json:"startTime,omitempty"`
// State - READ-ONLY; The current state of the operation.
State *string `json:"state,omitempty"`
// RequestedStorageLimitInMB - READ-ONLY; The requested storage limit in MB.
RequestedStorageLimitInMB *int32 `json:"requestedStorageLimitInMB,omitempty"`
// RequestedDatabaseDtuGuarantee - READ-ONLY; The requested per database DTU guarantee.
RequestedDatabaseDtuGuarantee *int32 `json:"requestedDatabaseDtuGuarantee,omitempty"`
// RequestedDatabaseDtuCap - READ-ONLY; The requested per database DTU cap.
RequestedDatabaseDtuCap *int32 `json:"requestedDatabaseDtuCap,omitempty"`
// RequestedDtuGuarantee - READ-ONLY; The requested DTU guarantee.
RequestedDtuGuarantee *int32 `json:"requestedDtuGuarantee,omitempty"`
}ElasticPoolActivityProperties represents the properties of an elastic pool.
type ElasticPoolDatabaseActivitiesClient struct {
BaseClient
}ElasticPoolDatabaseActivitiesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewElasticPoolDatabaseActivitiesClient(subscriptionID string) ElasticPoolDatabaseActivitiesClient
NewElasticPoolDatabaseActivitiesClient creates an instance of the ElasticPoolDatabaseActivitiesClient client.
func NewElasticPoolDatabaseActivitiesClientWithBaseURI(baseURI string, subscriptionID string) ElasticPoolDatabaseActivitiesClient
NewElasticPoolDatabaseActivitiesClientWithBaseURI creates an instance of the ElasticPoolDatabaseActivitiesClient 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 ElasticPoolDatabaseActivitiesClient) ListByElasticPool(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result ElasticPoolDatabaseActivityListResult, err error)
ListByElasticPool returns activity on databases inside of an elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool.
func (client ElasticPoolDatabaseActivitiesClient) ListByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
ListByElasticPoolPreparer prepares the ListByElasticPool request.
func (client ElasticPoolDatabaseActivitiesClient) ListByElasticPoolResponder(resp *http.Response) (result ElasticPoolDatabaseActivityListResult, err error)
ListByElasticPoolResponder handles the response to the ListByElasticPool request. The method always closes the http.Response Body.
func (client ElasticPoolDatabaseActivitiesClient) ListByElasticPoolSender(req *http.Request) (*http.Response, error)
ListByElasticPoolSender sends the ListByElasticPool request. The method will close the http.Response Body if it receives an error.
type ElasticPoolDatabaseActivity struct {
// Location - The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// ElasticPoolDatabaseActivityProperties - The properties representing the resource.
*ElasticPoolDatabaseActivityProperties `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"`
}ElasticPoolDatabaseActivity represents the activity on an elastic pool.
func (epda ElasticPoolDatabaseActivity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolDatabaseActivity.
func (epda *ElasticPoolDatabaseActivity) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ElasticPoolDatabaseActivity struct.
type ElasticPoolDatabaseActivityListResult struct {
autorest.Response `json:"-"`
// Value - The list of elastic pool database activities.
Value *[]ElasticPoolDatabaseActivity `json:"value,omitempty"`
}ElasticPoolDatabaseActivityListResult represents the response to a list elastic pool database activity request.
type ElasticPoolDatabaseActivityProperties struct {
// DatabaseName - READ-ONLY; The database name.
DatabaseName *string `json:"databaseName,omitempty"`
// EndTime - READ-ONLY; The time the operation finished (ISO8601 format).
EndTime *date.Time `json:"endTime,omitempty"`
// ErrorCode - READ-ONLY; The error code if available.
ErrorCode *int32 `json:"errorCode,omitempty"`
// ErrorMessage - READ-ONLY; The error message if available.
ErrorMessage *string `json:"errorMessage,omitempty"`
// ErrorSeverity - READ-ONLY; The error severity if available.
ErrorSeverity *int32 `json:"errorSeverity,omitempty"`
// Operation - READ-ONLY; The operation name.
Operation *string `json:"operation,omitempty"`
// OperationID - READ-ONLY; The unique operation ID.
OperationID *uuid.UUID `json:"operationId,omitempty"`
// PercentComplete - READ-ONLY; The percentage complete if available.
PercentComplete *int32 `json:"percentComplete,omitempty"`
// RequestedElasticPoolName - READ-ONLY; The name for the elastic pool the database is moving into if available.
RequestedElasticPoolName *string `json:"requestedElasticPoolName,omitempty"`
// CurrentElasticPoolName - READ-ONLY; The name of the current elastic pool the database is in if available.
CurrentElasticPoolName *string `json:"currentElasticPoolName,omitempty"`
// CurrentServiceObjective - READ-ONLY; The name of the current service objective if available.
CurrentServiceObjective *string `json:"currentServiceObjective,omitempty"`
// RequestedServiceObjective - READ-ONLY; The name of the requested service objective if available.
RequestedServiceObjective *string `json:"requestedServiceObjective,omitempty"`
// ServerName - READ-ONLY; The name of the server the elastic pool is in.
ServerName *string `json:"serverName,omitempty"`
// StartTime - READ-ONLY; The time the operation started (ISO8601 format).
StartTime *date.Time `json:"startTime,omitempty"`
// State - READ-ONLY; The current state of the operation.
State *string `json:"state,omitempty"`
}ElasticPoolDatabaseActivityProperties represents the properties of an elastic pool database activity.
type ElasticPoolDtuCapability struct {
// Limit - READ-ONLY; The DTU limit for the pool.
Limit *int32 `json:"limit,omitempty"`
// MaxDatabaseCount - READ-ONLY; The maximum number of databases supported.
MaxDatabaseCount *int32 `json:"maxDatabaseCount,omitempty"`
// IncludedMaxSize - READ-ONLY; The included (free) max size for this DTU.
IncludedMaxSize *MaxSizeCapability `json:"includedMaxSize,omitempty"`
// SupportedMaxSizes - READ-ONLY; The list of supported max sizes.
SupportedMaxSizes *[]MaxSizeCapability `json:"supportedMaxSizes,omitempty"`
// SupportedPerDatabaseMaxSizes - READ-ONLY; The list of supported per database max sizes.
SupportedPerDatabaseMaxSizes *[]MaxSizeCapability `json:"supportedPerDatabaseMaxSizes,omitempty"`
// SupportedPerDatabaseMaxDtus - READ-ONLY; The list of supported per database max DTUs.
SupportedPerDatabaseMaxDtus *[]ElasticPoolPerDatabaseMaxDtuCapability `json:"supportedPerDatabaseMaxDtus,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}ElasticPoolDtuCapability the Elastic Pool DTU capability.
func (epdc ElasticPoolDtuCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolDtuCapability.
ElasticPoolEdition enumerates the values for elastic pool edition.
const (
// ElasticPoolEditionBasic ...
ElasticPoolEditionBasic ElasticPoolEdition = "Basic"
// ElasticPoolEditionBusinessCritical ...
ElasticPoolEditionBusinessCritical ElasticPoolEdition = "BusinessCritical"
// ElasticPoolEditionGeneralPurpose ...
ElasticPoolEditionGeneralPurpose ElasticPoolEdition = "GeneralPurpose"
// ElasticPoolEditionPremium ...
ElasticPoolEditionPremium ElasticPoolEdition = "Premium"
// ElasticPoolEditionStandard ...
ElasticPoolEditionStandard ElasticPoolEdition = "Standard"
)func PossibleElasticPoolEditionValues() []ElasticPoolEdition
PossibleElasticPoolEditionValues returns an array of possible values for the ElasticPoolEdition const type.
type ElasticPoolEditionCapability struct {
// Name - READ-ONLY; The elastic pool edition name.
Name *string `json:"name,omitempty"`
// SupportedElasticPoolDtus - READ-ONLY; The list of supported elastic pool DTU levels for the edition.
SupportedElasticPoolDtus *[]ElasticPoolDtuCapability `json:"supportedElasticPoolDtus,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}ElasticPoolEditionCapability the elastic pool edition capability.
func (epec ElasticPoolEditionCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolEditionCapability.
type ElasticPoolListResult struct {
autorest.Response `json:"-"`
// Value - The list of elastic pools hosted in the server.
Value *[]ElasticPool `json:"value,omitempty"`
}ElasticPoolListResult represents the response to a list elastic pool request.
type ElasticPoolPerDatabaseMaxDtuCapability struct {
// Limit - READ-ONLY; The maximum DTUs per database.
Limit *int32 `json:"limit,omitempty"`
// SupportedPerDatabaseMinDtus - READ-ONLY; The list of supported min database DTUs.
SupportedPerDatabaseMinDtus *[]ElasticPoolPerDatabaseMinDtuCapability `json:"supportedPerDatabaseMinDtus,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}ElasticPoolPerDatabaseMaxDtuCapability the max per-database DTU capability.
func (eppdmdc ElasticPoolPerDatabaseMaxDtuCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolPerDatabaseMaxDtuCapability.
type ElasticPoolPerDatabaseMinDtuCapability struct {
// Limit - READ-ONLY; The minimum DTUs per database.
Limit *int32 `json:"limit,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}ElasticPoolPerDatabaseMinDtuCapability the minimum per-database DTU capability.
func (eppdmdc ElasticPoolPerDatabaseMinDtuCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolPerDatabaseMinDtuCapability.
type ElasticPoolProperties struct {
// CreationDate - READ-ONLY; The creation date of the elastic pool (ISO8601 format).
CreationDate *date.Time `json:"creationDate,omitempty"`
// State - READ-ONLY; The state of the elastic pool. Possible values include: 'ElasticPoolStateCreating', 'ElasticPoolStateReady', 'ElasticPoolStateDisabled'
State ElasticPoolState `json:"state,omitempty"`
// Edition - The edition of the elastic pool. Possible values include: 'ElasticPoolEditionBasic', 'ElasticPoolEditionStandard', 'ElasticPoolEditionPremium', 'ElasticPoolEditionGeneralPurpose', 'ElasticPoolEditionBusinessCritical'
Edition ElasticPoolEdition `json:"edition,omitempty"`
// Dtu - The total shared DTU for the database elastic pool.
Dtu *int32 `json:"dtu,omitempty"`
// DatabaseDtuMax - The maximum DTU any one database can consume.
DatabaseDtuMax *int32 `json:"databaseDtuMax,omitempty"`
// DatabaseDtuMin - The minimum DTU all databases are guaranteed.
DatabaseDtuMin *int32 `json:"databaseDtuMin,omitempty"`
// StorageMB - Gets storage limit for the database elastic pool in MB.
StorageMB *int32 `json:"storageMB,omitempty"`
// ZoneRedundant - Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
ZoneRedundant *bool `json:"zoneRedundant,omitempty"`
}ElasticPoolProperties represents the properties of an elastic pool.
func (epp ElasticPoolProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolProperties.
ElasticPoolState enumerates the values for elastic pool state.
const (
// ElasticPoolStateCreating ...
ElasticPoolStateCreating ElasticPoolState = "Creating"
// ElasticPoolStateDisabled ...
ElasticPoolStateDisabled ElasticPoolState = "Disabled"
// ElasticPoolStateReady ...
ElasticPoolStateReady ElasticPoolState = "Ready"
)func PossibleElasticPoolStateValues() []ElasticPoolState
PossibleElasticPoolStateValues returns an array of possible values for the ElasticPoolState const type.
type ElasticPoolUpdate struct {
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// ElasticPoolProperties - The properties representing the resource.
*ElasticPoolProperties `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"`
}ElasticPoolUpdate represents an elastic pool update.
func (epu ElasticPoolUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolUpdate.
func (epu *ElasticPoolUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ElasticPoolUpdate struct.
type ElasticPoolsClient struct {
BaseClient
}ElasticPoolsClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewElasticPoolsClient(subscriptionID string) ElasticPoolsClient
NewElasticPoolsClient creates an instance of the ElasticPoolsClient client.
func NewElasticPoolsClientWithBaseURI(baseURI string, subscriptionID string) ElasticPoolsClient
NewElasticPoolsClientWithBaseURI creates an instance of the ElasticPoolsClient 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 ElasticPoolsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, parameters ElasticPool) (result ElasticPoolsCreateOrUpdateFuture, err error)
CreateOrUpdate creates a new elastic pool or updates an existing elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be operated on (updated or created). parameters - the required parameters for creating or updating an elastic pool.
func (client ElasticPoolsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, parameters ElasticPool) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ElasticPoolsClient) CreateOrUpdateResponder(resp *http.Response) (result ElasticPool, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ElasticPoolsClient) CreateOrUpdateSender(req *http.Request) (future ElasticPoolsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ElasticPoolsClient) Delete(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result autorest.Response, err error)
Delete deletes the elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be deleted.
func (client ElasticPoolsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ElasticPoolsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ElasticPoolsClient) Get(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result ElasticPool, err error)
Get gets an elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be retrieved.
func (client ElasticPoolsClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ElasticPoolsClient) GetResponder(resp *http.Response) (result ElasticPool, 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 ElasticPoolsClient) ListByServer(ctx context.Context, resourceGroupName string, serverName string) (result ElasticPoolListResult, err error)
ListByServer returns a list of elastic pools in a server. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server.
func (client ElasticPoolsClient) ListByServerPreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
ListByServerPreparer prepares the ListByServer request.
func (client ElasticPoolsClient) ListByServerResponder(resp *http.Response) (result ElasticPoolListResult, err error)
ListByServerResponder handles the response to the ListByServer request. The method always closes the http.Response Body.
ListByServerSender sends the ListByServer request. The method will close the http.Response Body if it receives an error.
func (client ElasticPoolsClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result MetricDefinitionListResult, err error)
ListMetricDefinitions returns elastic pool metric definitions. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool.
func (client ElasticPoolsClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client ElasticPoolsClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client ElasticPoolsClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client ElasticPoolsClient) ListMetrics(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, filter string) (result MetricListResult, err error)
ListMetrics returns elastic pool metrics. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool. filter - an OData filter expression that describes a subset of metrics to return.
func (client ElasticPoolsClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client ElasticPoolsClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client ElasticPoolsClient) Update(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, parameters ElasticPoolUpdate) (result ElasticPoolsUpdateFuture, err error)
Update updates an existing elastic pool. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. elasticPoolName - the name of the elastic pool to be updated. parameters - the required parameters for updating an elastic pool.
func (client ElasticPoolsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, parameters ElasticPoolUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ElasticPoolsClient) UpdateResponder(resp *http.Response) (result ElasticPool, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ElasticPoolsClient) UpdateSender(req *http.Request) (future ElasticPoolsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ElasticPoolsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ElasticPoolsClient) (ElasticPool, error)
}ElasticPoolsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ElasticPoolsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ElasticPoolsClient) (ElasticPool, error)
}ElasticPoolsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EncryptionProtector struct {
autorest.Response `json:"-"`
// Kind - READ-ONLY; Kind of encryption protector. This is metadata used for the Azure portal experience.
Kind *string `json:"kind,omitempty"`
// Location - READ-ONLY; Resource location.
Location *string `json:"location,omitempty"`
// EncryptionProtectorProperties - Resource properties.
*EncryptionProtectorProperties `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"`
}EncryptionProtector the server encryption protector.
func (ep EncryptionProtector) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionProtector.
func (ep *EncryptionProtector) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EncryptionProtector struct.
type EncryptionProtectorListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]EncryptionProtector `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}EncryptionProtectorListResult a list of server encryption protectors.
func (eplr EncryptionProtectorListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type EncryptionProtectorListResultIterator struct {
// contains filtered or unexported fields
}EncryptionProtectorListResultIterator provides access to a complete listing of EncryptionProtector values.
func NewEncryptionProtectorListResultIterator(page EncryptionProtectorListResultPage) EncryptionProtectorListResultIterator
Creates a new instance of the EncryptionProtectorListResultIterator type.
func (iter *EncryptionProtectorListResultIterator) 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 *EncryptionProtectorListResultIterator) 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 EncryptionProtectorListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EncryptionProtectorListResultIterator) Response() EncryptionProtectorListResult
Response returns the raw server response from the last page request.
func (iter EncryptionProtectorListResultIterator) Value() EncryptionProtector
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type EncryptionProtectorListResultPage struct {
// contains filtered or unexported fields
}EncryptionProtectorListResultPage contains a page of EncryptionProtector values.
func NewEncryptionProtectorListResultPage(cur EncryptionProtectorListResult, getNextPage func(context.Context, EncryptionProtectorListResult) (EncryptionProtectorListResult, error)) EncryptionProtectorListResultPage
Creates a new instance of the EncryptionProtectorListResultPage type.
func (page *EncryptionProtectorListResultPage) 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 *EncryptionProtectorListResultPage) 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 EncryptionProtectorListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EncryptionProtectorListResultPage) Response() EncryptionProtectorListResult
Response returns the raw server response from the last page request.
func (page EncryptionProtectorListResultPage) Values() []EncryptionProtector
Values returns the slice of values for the current page or nil if there are no values.
type EncryptionProtectorProperties struct {
// Subregion - READ-ONLY; Subregion of the encryption protector.
Subregion *string `json:"subregion,omitempty"`
// ServerKeyName - The name of the server key.
ServerKeyName *string `json:"serverKeyName,omitempty"`
// ServerKeyType - The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Possible values include: 'ServiceManaged', 'AzureKeyVault'
ServerKeyType ServerKeyType `json:"serverKeyType,omitempty"`
// URI - READ-ONLY; The URI of the server key.
URI *string `json:"uri,omitempty"`
// Thumbprint - READ-ONLY; Thumbprint of the server key.
Thumbprint *string `json:"thumbprint,omitempty"`
}EncryptionProtectorProperties properties for an encryption protector execution.
func (epp EncryptionProtectorProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncryptionProtectorProperties.
type EncryptionProtectorsClient struct {
BaseClient
}EncryptionProtectorsClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewEncryptionProtectorsClient(subscriptionID string) EncryptionProtectorsClient
NewEncryptionProtectorsClient creates an instance of the EncryptionProtectorsClient client.
func NewEncryptionProtectorsClientWithBaseURI(baseURI string, subscriptionID string) EncryptionProtectorsClient
NewEncryptionProtectorsClientWithBaseURI creates an instance of the EncryptionProtectorsClient 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 EncryptionProtectorsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, parameters EncryptionProtector) (result EncryptionProtectorsCreateOrUpdateFuture, err error)
CreateOrUpdate updates an existing encryption protector. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. parameters - the requested encryption protector resource state.
func (client EncryptionProtectorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, parameters EncryptionProtector) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client EncryptionProtectorsClient) CreateOrUpdateResponder(resp *http.Response) (result EncryptionProtector, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client EncryptionProtectorsClient) CreateOrUpdateSender(req *http.Request) (future EncryptionProtectorsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client EncryptionProtectorsClient) Get(ctx context.Context, resourceGroupName string, serverName string) (result EncryptionProtector, err error)
Get gets a server encryption protector. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server.
func (client EncryptionProtectorsClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client EncryptionProtectorsClient) GetResponder(resp *http.Response) (result EncryptionProtector, 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 EncryptionProtectorsClient) ListByServer(ctx context.Context, resourceGroupName string, serverName string) (result EncryptionProtectorListResultPage, err error)
ListByServer gets a list of server encryption protectors Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server.
func (client EncryptionProtectorsClient) ListByServerComplete(ctx context.Context, resourceGroupName string, serverName string) (result EncryptionProtectorListResultIterator, err error)
ListByServerComplete enumerates all values, automatically crossing page boundaries as required.
func (client EncryptionProtectorsClient) ListByServerPreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
ListByServerPreparer prepares the ListByServer request.
func (client EncryptionProtectorsClient) ListByServerResponder(resp *http.Response) (result EncryptionProtectorListResult, err error)
ListByServerResponder handles the response to the ListByServer request. The method always closes the http.Response Body.
func (client EncryptionProtectorsClient) ListByServerSender(req *http.Request) (*http.Response, error)
ListByServerSender sends the ListByServer request. The method will close the http.Response Body if it receives an error.
func (client EncryptionProtectorsClient) Revalidate(ctx context.Context, resourceGroupName string, serverName string) (result EncryptionProtectorsRevalidateFuture, err error)
Revalidate revalidates an existing encryption protector. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server.
func (client EncryptionProtectorsClient) RevalidatePreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
RevalidatePreparer prepares the Revalidate request.
func (client EncryptionProtectorsClient) RevalidateResponder(resp *http.Response) (result autorest.Response, err error)
RevalidateResponder handles the response to the Revalidate request. The method always closes the http.Response Body.
func (client EncryptionProtectorsClient) RevalidateSender(req *http.Request) (future EncryptionProtectorsRevalidateFuture, err error)
RevalidateSender sends the Revalidate request. The method will close the http.Response Body if it receives an error.
type EncryptionProtectorsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EncryptionProtectorsClient) (EncryptionProtector, error)
}EncryptionProtectorsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EncryptionProtectorsRevalidateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EncryptionProtectorsClient) (autorest.Response, error)
}EncryptionProtectorsRevalidateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExportRequest struct {
// StorageKeyType - The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'
StorageKeyType StorageKeyType `json:"storageKeyType,omitempty"`
// StorageKey - The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."
StorageKey *string `json:"storageKey,omitempty"`
// StorageURI - The storage uri to use.
StorageURI *string `json:"storageUri,omitempty"`
// AdministratorLogin - The name of the SQL administrator.
AdministratorLogin *string `json:"administratorLogin,omitempty"`
// AdministratorLoginPassword - The password of the SQL administrator.
AdministratorLoginPassword *string `json:"administratorLoginPassword,omitempty"`
// AuthenticationType - The authentication type. Possible values include: 'SQL', 'ADPassword'
AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
}ExportRequest export database parameters.
type FailoverGroup struct {
autorest.Response `json:"-"`
// Location - READ-ONLY; Resource location.
Location *string `json:"location,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// FailoverGroupProperties - Resource properties.
*FailoverGroupProperties `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"`
}FailoverGroup a failover group.
func (fg FailoverGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FailoverGroup.
func (fg *FailoverGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FailoverGroup struct.
type FailoverGroupListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]FailoverGroup `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}FailoverGroupListResult a list of failover groups.
func (fglr FailoverGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type FailoverGroupListResultIterator struct {
// contains filtered or unexported fields
}FailoverGroupListResultIterator provides access to a complete listing of FailoverGroup values.
func NewFailoverGroupListResultIterator(page FailoverGroupListResultPage) FailoverGroupListResultIterator
Creates a new instance of the FailoverGroupListResultIterator type.
func (iter *FailoverGroupListResultIterator) 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 *FailoverGroupListResultIterator) 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 FailoverGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter FailoverGroupListResultIterator) Response() FailoverGroupListResult
Response returns the raw server response from the last page request.
func (iter FailoverGroupListResultIterator) Value() FailoverGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type FailoverGroupListResultPage struct {
// contains filtered or unexported fields
}FailoverGroupListResultPage contains a page of FailoverGroup values.
func NewFailoverGroupListResultPage(cur FailoverGroupListResult, getNextPage func(context.Context, FailoverGroupListResult) (FailoverGroupListResult, error)) FailoverGroupListResultPage
Creates a new instance of the FailoverGroupListResultPage type.
func (page *FailoverGroupListResultPage) 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 *FailoverGroupListResultPage) 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 FailoverGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page FailoverGroupListResultPage) Response() FailoverGroupListResult
Response returns the raw server response from the last page request.
func (page FailoverGroupListResultPage) Values() []FailoverGroup
Values returns the slice of values for the current page or nil if there are no values.
type FailoverGroupProperties struct {
// ReadWriteEndpoint - Read-write endpoint of the failover group instance.
ReadWriteEndpoint *FailoverGroupReadWriteEndpoint `json:"readWriteEndpoint,omitempty"`
// ReadOnlyEndpoint - Read-only endpoint of the failover group instance.
ReadOnlyEndpoint *FailoverGroupReadOnlyEndpoint `json:"readOnlyEndpoint,omitempty"`
// ReplicationRole - READ-ONLY; Local replication role of the failover group instance. Possible values include: 'Primary', 'Secondary'
ReplicationRole FailoverGroupReplicationRole `json:"replicationRole,omitempty"`
// ReplicationState - READ-ONLY; Replication state of the failover group instance.
ReplicationState *string `json:"replicationState,omitempty"`
// PartnerServers - List of partner server information for the failover group.
PartnerServers *[]PartnerInfo `json:"partnerServers,omitempty"`
// Databases - List of databases in the failover group.
Databases *[]string `json:"databases,omitempty"`
}FailoverGroupProperties properties of a failover group.
func (fgp FailoverGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FailoverGroupProperties.
type FailoverGroupReadOnlyEndpoint struct {
// FailoverPolicy - Failover policy of the read-only endpoint for the failover group. Possible values include: 'ReadOnlyEndpointFailoverPolicyDisabled', 'ReadOnlyEndpointFailoverPolicyEnabled'
FailoverPolicy ReadOnlyEndpointFailoverPolicy `json:"failoverPolicy,omitempty"`
}FailoverGroupReadOnlyEndpoint read-only endpoint of the failover group instance.
type FailoverGroupReadWriteEndpoint struct {
// FailoverPolicy - Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: 'Manual', 'Automatic'
FailoverPolicy ReadWriteEndpointFailoverPolicy `json:"failoverPolicy,omitempty"`
// FailoverWithDataLossGracePeriodMinutes - Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
FailoverWithDataLossGracePeriodMinutes *int32 `json:"failoverWithDataLossGracePeriodMinutes,omitempty"`
}FailoverGroupReadWriteEndpoint read-write endpoint of the failover group instance.
FailoverGroupReplicationRole enumerates the values for failover group replication role.
const (
// Primary ...
Primary FailoverGroupReplicationRole = "Primary"
// Secondary ...
Secondary FailoverGroupReplicationRole = "Secondary"
)func PossibleFailoverGroupReplicationRoleValues() []FailoverGroupReplicationRole
PossibleFailoverGroupReplicationRoleValues returns an array of possible values for the FailoverGroupReplicationRole const type.
type FailoverGroupUpdate struct {
// FailoverGroupUpdateProperties - Resource properties.
*FailoverGroupUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}FailoverGroupUpdate a failover group update request.
func (fgu FailoverGroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FailoverGroupUpdate.
func (fgu *FailoverGroupUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FailoverGroupUpdate struct.
type FailoverGroupUpdateProperties struct {
// ReadWriteEndpoint - Read-write endpoint of the failover group instance.
ReadWriteEndpoint *FailoverGroupReadWriteEndpoint `json:"readWriteEndpoint,omitempty"`
// ReadOnlyEndpoint - Read-only endpoint of the failover group instance.
ReadOnlyEndpoint *FailoverGroupReadOnlyEndpoint `json:"readOnlyEndpoint,omitempty"`
// Databases - List of databases in the failover group.
Databases *[]string `json:"databases,omitempty"`
}FailoverGroupUpdateProperties properties of a failover group update.
type FailoverGroupsClient struct {
BaseClient
}FailoverGroupsClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewFailoverGroupsClient(subscriptionID string) FailoverGroupsClient
NewFailoverGroupsClient creates an instance of the FailoverGroupsClient client.
func NewFailoverGroupsClientWithBaseURI(baseURI string, subscriptionID string) FailoverGroupsClient
NewFailoverGroupsClientWithBaseURI creates an instance of the FailoverGroupsClient 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 FailoverGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string, parameters FailoverGroup) (result FailoverGroupsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a failover group. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group. parameters - the failover group parameters.
func (client FailoverGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string, parameters FailoverGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client FailoverGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result FailoverGroup, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client FailoverGroupsClient) CreateOrUpdateSender(req *http.Request) (future FailoverGroupsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client FailoverGroupsClient) Delete(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (result FailoverGroupsDeleteFuture, err error)
Delete deletes a failover group. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group.
func (client FailoverGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client FailoverGroupsClient) 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 FailoverGroupsClient) DeleteSender(req *http.Request) (future FailoverGroupsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client FailoverGroupsClient) Failover(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (result FailoverGroupsFailoverFuture, err error)
Failover fails over from the current primary server to this server. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group.
func (client FailoverGroupsClient) FailoverPreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (*http.Request, error)
FailoverPreparer prepares the Failover request.
func (client FailoverGroupsClient) FailoverResponder(resp *http.Response) (result FailoverGroup, err error)
FailoverResponder handles the response to the Failover request. The method always closes the http.Response Body.
func (client FailoverGroupsClient) FailoverSender(req *http.Request) (future FailoverGroupsFailoverFuture, err error)
FailoverSender sends the Failover request. The method will close the http.Response Body if it receives an error.
func (client FailoverGroupsClient) ForceFailoverAllowDataLoss(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (result FailoverGroupsForceFailoverAllowDataLossFuture, err error)
ForceFailoverAllowDataLoss fails over from the current primary server to this server. This operation might result in data loss. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group.
func (client FailoverGroupsClient) ForceFailoverAllowDataLossPreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (*http.Request, error)
ForceFailoverAllowDataLossPreparer prepares the ForceFailoverAllowDataLoss request.
func (client FailoverGroupsClient) ForceFailoverAllowDataLossResponder(resp *http.Response) (result FailoverGroup, err error)
ForceFailoverAllowDataLossResponder handles the response to the ForceFailoverAllowDataLoss request. The method always closes the http.Response Body.
func (client FailoverGroupsClient) ForceFailoverAllowDataLossSender(req *http.Request) (future FailoverGroupsForceFailoverAllowDataLossFuture, err error)
ForceFailoverAllowDataLossSender sends the ForceFailoverAllowDataLoss request. The method will close the http.Response Body if it receives an error.
func (client FailoverGroupsClient) Get(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (result FailoverGroup, err error)
Get gets a failover group. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group.
func (client FailoverGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client FailoverGroupsClient) GetResponder(resp *http.Response) (result FailoverGroup, 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 FailoverGroupsClient) ListByServer(ctx context.Context, resourceGroupName string, serverName string) (result FailoverGroupListResultPage, err error)
ListByServer lists the failover groups in a server. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group.
func (client FailoverGroupsClient) ListByServerComplete(ctx context.Context, resourceGroupName string, serverName string) (result FailoverGroupListResultIterator, err error)
ListByServerComplete enumerates all values, automatically crossing page boundaries as required.
func (client FailoverGroupsClient) ListByServerPreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
ListByServerPreparer prepares the ListByServer request.
func (client FailoverGroupsClient) ListByServerResponder(resp *http.Response) (result FailoverGroupListResult, err error)
ListByServerResponder handles the response to the ListByServer request. The method always closes the http.Response Body.
ListByServerSender sends the ListByServer request. The method will close the http.Response Body if it receives an error.
func (client FailoverGroupsClient) Update(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string, parameters FailoverGroupUpdate) (result FailoverGroupsUpdateFuture, err error)
Update updates a failover group. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server containing the failover group. failoverGroupName - the name of the failover group. parameters - the failover group parameters.
func (client FailoverGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, failoverGroupName string, parameters FailoverGroupUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client FailoverGroupsClient) UpdateResponder(resp *http.Response) (result FailoverGroup, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client FailoverGroupsClient) UpdateSender(req *http.Request) (future FailoverGroupsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type FailoverGroupsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FailoverGroupsClient) (FailoverGroup, error)
}FailoverGroupsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FailoverGroupsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FailoverGroupsClient) (autorest.Response, error)
}FailoverGroupsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FailoverGroupsFailoverFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FailoverGroupsClient) (FailoverGroup, error)
}FailoverGroupsFailoverFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FailoverGroupsForceFailoverAllowDataLossFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FailoverGroupsClient) (FailoverGroup, error)
}FailoverGroupsForceFailoverAllowDataLossFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FailoverGroupsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FailoverGroupsClient) (FailoverGroup, error)
}FailoverGroupsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FirewallRule struct {
autorest.Response `json:"-"`
// Kind - READ-ONLY; Kind of server that contains this firewall rule.
Kind *string `json:"kind,omitempty"`
// Location - READ-ONLY; Location of the server that contains this firewall rule.
Location *string `json:"location,omitempty"`
// FirewallRuleProperties - The properties representing the resource.
*FirewallRuleProperties `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"`
}FirewallRule represents a server firewall rule.
func (fr FirewallRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FirewallRule.
func (fr *FirewallRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FirewallRule struct.
type FirewallRuleListResult struct {
autorest.Response `json:"-"`
// Value - The list of server firewall rules.
Value *[]FirewallRule `json:"value,omitempty"`
}FirewallRuleListResult represents the response to a List Firewall Rules request.
type FirewallRuleProperties struct {
// StartIPAddress - The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.
StartIPAddress *string `json:"startIpAddress,omitempty"`
// EndIPAddress - The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.
EndIPAddress *string `json:"endIpAddress,omitempty"`
}FirewallRuleProperties represents the properties of a server firewall rule.
type FirewallRulesClient struct {
BaseClient
}FirewallRulesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewFirewallRulesClient(subscriptionID string) FirewallRulesClient
NewFirewallRulesClient creates an instance of the FirewallRulesClient client.
func NewFirewallRulesClientWithBaseURI(baseURI string, subscriptionID string) FirewallRulesClient
NewFirewallRulesClientWithBaseURI creates an instance of the FirewallRulesClient 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 FirewallRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string, parameters FirewallRule) (result FirewallRule, err error)
CreateOrUpdate creates or updates a firewall rule. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. firewallRuleName - the name of the firewall rule. parameters - the required parameters for creating or updating a firewall rule.
func (client FirewallRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string, parameters FirewallRule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client FirewallRulesClient) CreateOrUpdateResponder(resp *http.Response) (result FirewallRule, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client FirewallRulesClient) Delete(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string) (result autorest.Response, err error)
Delete deletes a firewall rule. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. firewallRuleName - the name of the firewall rule.
func (client FirewallRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client FirewallRulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client FirewallRulesClient) Get(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string) (result FirewallRule, err error)
Get gets a firewall rule. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. firewallRuleName - the name of the firewall rule.
func (client FirewallRulesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, firewallRuleName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client FirewallRulesClient) GetResponder(resp *http.Response) (result FirewallRule, 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 FirewallRulesClient) ListByServer(ctx context.Context, resourceGroupName string, serverName string) (result FirewallRuleListResult, err error)
ListByServer returns a list of firewall rules. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server.
func (client FirewallRulesClient) ListByServerPreparer(ctx context.Context, resourceGroupName string, serverName string) (*http.Request, error)
ListByServerPreparer prepares the ListByServer request.
func (client FirewallRulesClient) ListByServerResponder(resp *http.Response) (result FirewallRuleListResult, err error)
ListByServerResponder handles the response to the ListByServer request. The method always closes the http.Response Body.
ListByServerSender sends the ListByServer request. The method will close the http.Response Body if it receives an error.
type GeoBackupPoliciesClient struct {
BaseClient
}GeoBackupPoliciesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewGeoBackupPoliciesClient(subscriptionID string) GeoBackupPoliciesClient
NewGeoBackupPoliciesClient creates an instance of the GeoBackupPoliciesClient client.
func NewGeoBackupPoliciesClientWithBaseURI(baseURI string, subscriptionID string) GeoBackupPoliciesClient
NewGeoBackupPoliciesClientWithBaseURI creates an instance of the GeoBackupPoliciesClient 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 GeoBackupPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters GeoBackupPolicy) (result GeoBackupPolicy, err error)
CreateOrUpdate updates a database geo backup policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database. parameters - the required parameters for creating or updating the geo backup policy.
func (client GeoBackupPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, parameters GeoBackupPolicy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GeoBackupPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result GeoBackupPolicy, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GeoBackupPoliciesClient) 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 GeoBackupPoliciesClient) Get(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result GeoBackupPolicy, err error)
Get gets a geo backup policy. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client GeoBackupPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GeoBackupPoliciesClient) GetResponder(resp *http.Response) (result GeoBackupPolicy, 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 GeoBackupPoliciesClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result GeoBackupPolicyListResult, err error)
ListByDatabase returns a list of geo backup policies. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. serverName - the name of the server. databaseName - the name of the database.
func (client GeoBackupPoliciesClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListByDatabasePreparer prepares the ListByDatabase request.
func (client GeoBackupPoliciesClient) ListByDatabaseResponder(resp *http.Response) (result GeoBackupPolicyListResult, err error)
ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.
func (client GeoBackupPoliciesClient) ListByDatabaseSender(req *http.Request) (*http.Response, error)
ListByDatabaseSender sends the ListByDatabase request. The method will close the http.Response Body if it receives an error.
type GeoBackupPolicy struct {
autorest.Response `json:"-"`
// GeoBackupPolicyProperties - The properties of the geo backup policy.
*GeoBackupPolicyProperties `json:"properties,omitempty"`
// Kind - READ-ONLY; Kind of geo backup policy. This is metadata used for the Azure portal experience.
Kind *string `json:"kind,omitempty"`
// Location - READ-ONLY; Backup policy location.
Location *string `json:"location,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"`
}GeoBackupPolicy a database geo backup policy.
func (gbp GeoBackupPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GeoBackupPolicy.
func (gbp *GeoBackupPolicy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GeoBackupPolicy struct.
type GeoBackupPolicyListResult struct {
autorest.Response `json:"-"`
// Value - The list of geo backup policies.
Value *[]GeoBackupPolicy `json:"value,omitempty"`
}GeoBackupPolicyListResult the response to a list geo backup policies request.
type GeoBackupPolicyProperties struct {
// State - The state of the geo backup policy. Possible values include: 'GeoBackupPolicyStateDisabled', 'GeoBackupPolicyStateEnabled'
State GeoBackupPolicyState `json:"state,omitempty"`
// StorageType - READ-ONLY; The storage type of the geo backup policy.
StorageType *string `json:"storageType,omitempty"`
}GeoBackupPolicyProperties the properties of the geo backup policy.
func (gbpp GeoBackupPolicyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GeoBackupPolicyProperties.
GeoBackupPolicyState enumerates the values for geo backup policy state.
const (
// GeoBackupPolicyStateDisabled ...
GeoBackupPolicyStateDisabled GeoBackupPolicyState = "Disabled"
// GeoBackupPolicyStateEnabled ...
GeoBackupPolicyStateEnabled GeoBackupPolicyState = "Enabled"
)func PossibleGeoBackupPolicyStateValues() []GeoBackupPolicyState
PossibleGeoBackupPolicyStateValues returns an array of possible values for the GeoBackupPolicyState const type.
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 ImportExportResponse struct {
autorest.Response `json:"-"`
// ImportExportResponseProperties - The import/export operation properties.
*ImportExportResponseProperties `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"`
}ImportExportResponse response for Import/Export Get operation.
func (ier ImportExportResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImportExportResponse.
func (ier *ImportExportResponse) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ImportExportResponse struct.
type ImportExportResponseProperties struct {
// RequestType - READ-ONLY; The request type of the operation.
RequestType *string `json:"requestType,omitempty"`
// RequestID - READ-ONLY; The request type of the operation.
RequestID *uuid.UUID `json:"requestId,omitempty"`
// ServerName - READ-ONLY; The name of the server.
ServerName *string `json:"serverName,omitempty"`
// DatabaseName - READ-ONLY; The name of the database.
DatabaseName *string `json:"databaseName,omitempty"`
// Status - READ-ONLY; The status message returned from the server.
Status *string `json:"status,omitempty"`
// LastModifiedTime - READ-ONLY; The operation status last modified time.
LastModifiedTime *string `json:"lastModifiedTime,omitempty"`
// QueuedTime - READ-ONLY; The operation queued time.
QueuedTime *string `json:"queuedTime,omitempty"`
// BlobURI - READ-ONLY; The blob uri.
BlobURI *string `json:"blobUri,omitempty"`
// ErrorMessage - READ-ONLY; The error message returned from the server.
ErrorMessage *string `json:"errorMessage,omitempty"`
}ImportExportResponseProperties response for Import/Export Status operation.
type ImportExtensionProperties struct {
// OperationMode - The type of import operation being performed. This is always Import.
OperationMode *string `json:"operationMode,omitempty"`
// StorageKeyType - The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'
StorageKeyType StorageKeyType `json:"storageKeyType,omitempty"`
// StorageKey - The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."
StorageKey *string `json:"storageKey,omitempty"`
// StorageURI - The storage uri to use.
StorageURI *string `json:"storageUri,omitempty"`
// AdministratorLogin - The name of the SQL administrator.
AdministratorLogin *string `json:"administratorLogin,omitempty"`
// AdministratorLoginPassword - The password of the SQL administrator.
AdministratorLoginPassword *string `json:"administratorLoginPassword,omitempty"`
// AuthenticationType - The authentication type. Possible values include: 'SQL', 'ADPassword'
AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
}ImportExtensionProperties represents the properties for an import operation
type ImportExtensionRequest struct {
// Name - The name of the extension.
Name *string `json:"name,omitempty"`
// Type - The type of the extension.
Type *string `json:"type,omitempty"`
// ImportExtensionProperties - Represents the properties of the resource.
*ImportExtensionProperties `json:"properties,omitempty"`
}ImportExtensionRequest import database parameters.
func (ier ImportExtensionRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImportExtensionRequest.
func (ier *ImportExtensionRequest) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ImportExtensionRequest struct.
type ImportRequest struct {
// DatabaseName - The name of the database to import.
DatabaseName *string `json:"databaseName,omitempty"`
// Edition - The edition for the database being created.
//
// The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:
//
// ```azurecli
// az sql db list-editions -l <location> -o table
// ````
//
// ```powershell
// Get-AzSqlServerServiceObjective -Location <location>
// ````
// . Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'
Edition DatabaseEdition `json:"edition,omitempty"`
// ServiceObjectiveName - The name of the service objective to assign to the database. Possible values include: 'ServiceObjectiveNameSystem', 'ServiceObjectiveNameSystem0', 'ServiceObjectiveNameSystem1', 'ServiceObjectiveNameSystem2', 'ServiceObjectiveNameSystem3', 'ServiceObjectiveNameSystem4', 'ServiceObjectiveNameSystem2L', 'ServiceObjectiveNameSystem3L', 'ServiceObjectiveNameSystem4L', 'ServiceObjectiveNameFree', 'ServiceObjectiveNameBasic', 'ServiceObjectiveNameS0', 'ServiceObjectiveNameS1', 'ServiceObjectiveNameS2', 'ServiceObjectiveNameS3', 'ServiceObjectiveNameS4', 'ServiceObjectiveNameS6', 'ServiceObjectiveNameS7', 'ServiceObjectiveNameS9', 'ServiceObjectiveNameS12', 'ServiceObjectiveNameP1', 'ServiceObjectiveNameP2', 'ServiceObjectiveNameP3', 'ServiceObjectiveNameP4', 'ServiceObjectiveNameP6', 'ServiceObjectiveNameP11', 'ServiceObjectiveNameP15', 'ServiceObjectiveNamePRS1', 'ServiceObjectiveNamePRS2', 'ServiceObjectiveNamePRS4', 'ServiceObjectiveNamePRS6', 'ServiceObjectiveNameDW100', 'ServiceObjectiveNameDW200', 'ServiceObjectiveNameDW300', 'ServiceObjectiveNameDW400', 'ServiceObjectiveNameDW500', 'ServiceObjectiveNameDW600', 'ServiceObjectiveNameDW1000', 'ServiceObjectiveNameDW1200', 'ServiceObjectiveNameDW1000c', 'ServiceObjectiveNameDW1500', 'ServiceObjectiveNameDW1500c', 'ServiceObjectiveNameDW2000', 'ServiceObjectiveNameDW2000c', 'ServiceObjectiveNameDW3000', 'ServiceObjectiveNameDW2500c', 'ServiceObjectiveNameDW3000c', 'ServiceObjectiveNameDW6000', 'ServiceObjectiveNameDW5000c', 'ServiceObjectiveNameDW6000c', 'ServiceObjectiveNameDW7500c', 'ServiceObjectiveNameDW10000c', 'ServiceObjectiveNameDW15000c', 'ServiceObjectiveNameDW30000c', 'ServiceObjectiveNameDS100', 'ServiceObjectiveNameDS200', 'ServiceObjectiveNameDS300', 'ServiceObjectiveNameDS400', 'ServiceObjectiveNameDS500', 'ServiceObjectiveNameDS600', 'ServiceObjectiveNameDS1000', 'ServiceObjectiveNameDS1200', 'ServiceObjectiveNameDS1500', 'ServiceObjectiveNameDS2000', 'ServiceObjectiveNameElasticPool'
ServiceObjectiveName ServiceObjectiveName `json:"serviceObjectiveName,omitempty"`
// MaxSizeBytes - The maximum size for the newly imported database.
MaxSizeBytes *string `json:"maxSizeBytes,omitempty"`
// StorageKeyType - The type of the storage key to use. Possible values include: 'StorageAccessKey', 'SharedAccessKey'
StorageKeyType StorageKeyType `json:"storageKeyType,omitempty"`
// StorageKey - The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."
StorageKey *string `json:"storageKey,omitempty"`
// StorageURI - The storage uri to use.
StorageURI *string `json:"storageUri,omitempty"`
// AdministratorLogin - The name of the SQL administrator.
AdministratorLogin *string `json:"administratorLogin,omitempty"`
// AdministratorLoginPassword - The password of the SQL administrator.
AdministratorLoginPassword *string `json:"administratorLoginPassword,omitempty"`
// AuthenticationType - The authentication type. Possible values include: 'SQL', 'ADPassword'
AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
}ImportRequest import database parameters.
type LocationCapabilities struct {
autorest.Response `json:"-"`
// Name - READ-ONLY; The location name.
Name *string `json:"name,omitempty"`
// SupportedServerVersions - READ-ONLY; The list of supported server versions.
SupportedServerVersions *[]ServerVersionCapability `json:"supportedServerVersions,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}LocationCapabilities the location capability.
func (lc LocationCapabilities) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LocationCapabilities.
type ManagedInstance struct {
autorest.Response `json:"-"`
// Identity - The Azure Active Directory identity of the managed instance.
Identity *ResourceIdentity `json:"identity,omitempty"`
// Sku - Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5
Sku *Sku `json:"sku,omitempty"`
// ManagedInstanceProperties - Resource properties.
*ManagedInstanceProperties `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"`
}ManagedInstance an Azure SQL managed instance.
func (mi ManagedInstance) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedInstance.
func (mi *ManagedInstance) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ManagedInstance struct.
ManagedInstanceLicenseType enumerates the values for managed instance license type.
const (
// BasePrice ...
BasePrice ManagedInstanceLicenseType = "BasePrice"
// LicenseIncluded ...
LicenseIncluded ManagedInstanceLicenseType = "LicenseIncluded"
)func PossibleManagedInstanceLicenseTypeValues() []ManagedInstanceLicenseType
PossibleManagedInstanceLicenseTypeValues returns an array of possible values for the ManagedInstanceLicenseType const type.
type ManagedInstanceListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Array of results.
Value *[]ManagedInstance `json:"value,omitempty"`
// NextLink - READ-ONLY; Link to retrieve next page of results.
NextLink *string `json:"nextLink,omitempty"`
}ManagedInstanceListResult a list of managed instances.
func (milr ManagedInstanceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ManagedInstanceListResultIterator struct {
// contains filtered or unexported fields
}ManagedInstanceListResultIterator provides access to a complete listing of ManagedInstance values.
func NewManagedInstanceListResultIterator(page ManagedInstanceListResultPage) ManagedInstanceListResultIterator
Creates a new instance of the ManagedInstanceListResultIterator type.
func (iter *ManagedInstanceListResultIterator) 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 *ManagedInstanceListResultIterator) 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 ManagedInstanceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ManagedInstanceListResultIterator) Response() ManagedInstanceListResult
Response returns the raw server response from the last page request.
func (iter ManagedInstanceListResultIterator) Value() ManagedInstance
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ManagedInstanceListResultPage struct {
// contains filtered or unexported fields
}ManagedInstanceListResultPage contains a page of ManagedInstance values.
func NewManagedInstanceListResultPage(cur ManagedInstanceListResult, getNextPage func(context.Context, ManagedInstanceListResult) (ManagedInstanceListResult, error)) ManagedInstanceListResultPage
Creates a new instance of the ManagedInstanceListResultPage type.
func (page *ManagedInstanceListResultPage) 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 *ManagedInstanceListResultPage) 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 ManagedInstanceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ManagedInstanceListResultPage) Response() ManagedInstanceListResult
Response returns the raw server response from the last page request.
func (page ManagedInstanceListResultPage) Values() []ManagedInstance
Values returns the slice of values for the current page or nil if there are no values.
type ManagedInstanceProperties struct {
// ManagedInstanceCreateMode - Specifies the mode of database creation.
//
// Default: Regular instance creation.
//
// Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. Possible values include: 'ManagedServerCreateModeDefault', 'ManagedServerCreateModePointInTimeRestore'
ManagedInstanceCreateMode ManagedServerCreateMode `json:"managedInstanceCreateMode,omitempty"`
// FullyQualifiedDomainName - READ-ONLY; The fully qualified domain name of the managed instance.
FullyQualifiedDomainName *string `json:"fullyQualifiedDomainName,omitempty"`
// AdministratorLogin - Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
AdministratorLogin *string `json:"administratorLogin,omitempty"`
// AdministratorLoginPassword - The administrator login password (required for managed instance creation).
AdministratorLoginPassword *string `json:"administratorLoginPassword,omitempty"`
// SubnetID - Subnet resource ID for the managed instance.
SubnetID *string `json:"subnetId,omitempty"`
// State - READ-ONLY; The state of the managed instance.
State *string `json:"state,omitempty"`
// LicenseType - The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). Possible values include: 'LicenseIncluded', 'BasePrice'
LicenseType ManagedInstanceLicenseType `json:"licenseType,omitempty"`
// VCores - The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
VCores *int32 `json:"vCores,omitempty"`
// StorageSizeInGB - Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
StorageSizeInGB *int32 `json:"storageSizeInGB,omitempty"`
// Collation - Collation of the managed instance.
Collation *string `json:"collation,omitempty"`
// DNSZone - READ-ONLY; The Dns Zone that the managed instance is in.
DNSZone *string `json:"dnsZone,omitempty"`
// DNSZonePartner - The resource id of another managed instance whose DNS zone this managed instance will share after creation.
DNSZonePartner *string `json:"dnsZonePartner,omitempty"`
// PublicDataEndpointEnabled - Whether or not the public data endpoint is enabled.
PublicDataEndpointEnabled *bool `json:"publicDataEndpointEnabled,omitempty"`
// SourceManagedInstanceID - The resource identifier of the source managed instance associated with create operation of this instance.
SourceManagedInstanceID *string `json:"sourceManagedInstanceId,omitempty"`
// RestorePointInTime - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
RestorePointInTime *date.Time `json:"restorePointInTime,omitempty"`
// ProxyOverride - Connection type used for connecting to the instance. Possible values include: 'ManagedInstanceProxyOverrideProxy', 'ManagedInstanceProxyOverrideRedirect', 'ManagedInstanceProxyOverrideDefault'
ProxyOverride ManagedInstanceProxyOverride `json:"proxyOverride,omitempty"`
// TimezoneID - Id of the timezone. Allowed values are timezones supported by Windows.
// Windows keeps details on supported timezones, including the id, in registry under
// KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones.
// You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info.
// List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.
// An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".
TimezoneID *string `json:"timezoneId,omitempty"`
// InstancePoolID - The Id of the instance pool this managed server belongs to.
InstancePoolID *string `json:"instancePoolId,omitempty"`
// MaintenanceConfigurationID - Specifies maintenance configuration id to apply to this managed instance.
MaintenanceConfigurationID *string `json:"maintenanceConfigurationId,omitempty"`
// MinimalTLSVersion - Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
MinimalTLSVersion *string `json:"minimalTlsVersion,omitempty"`
}ManagedInstanceProperties the properties of a managed instance.
func (mip ManagedInstanceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedInstanceProperties.
ManagedInstanceProxyOverride enumerates the values for managed instance proxy override.
const (
// ManagedInstanceProxyOverrideDefault ...
ManagedInstanceProxyOverrideDefault ManagedInstanceProxyOverride = "Default"
// ManagedInstanceProxyOverrideProxy ...
ManagedInstanceProxyOverrideProxy ManagedInstanceProxyOverride = "Proxy"
// ManagedInstanceProxyOverrideRedirect ...
ManagedInstanceProxyOverrideRedirect ManagedInstanceProxyOverride = "Redirect"
)func PossibleManagedInstanceProxyOverrideValues() []ManagedInstanceProxyOverride
PossibleManagedInstanceProxyOverrideValues returns an array of possible values for the ManagedInstanceProxyOverride const type.
type ManagedInstanceUpdate struct {
// Sku - Managed instance sku
Sku *Sku `json:"sku,omitempty"`
// ManagedInstanceProperties - Resource properties.
*ManagedInstanceProperties `json:"properties,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}ManagedInstanceUpdate an update request for an Azure SQL Database managed instance.
func (miu ManagedInstanceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedInstanceUpdate.
func (miu *ManagedInstanceUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ManagedInstanceUpdate struct.
type ManagedInstancesClient struct {
BaseClient
}ManagedInstancesClient is the the Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.
func NewManagedInstancesClient(subscriptionID string) ManagedInstancesClient
NewManagedInstancesClient creates an instance of the ManagedInstancesClient client.
func NewManagedInstancesClientWithBaseURI(baseURI string, subscriptionID string) ManagedInstancesClient
NewManagedInstancesClientWithBaseURI creates an instance of the ManagedInstancesClient 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 ManagedInstancesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, managedInstanceName string, parameters ManagedInstance) (result ManagedInstancesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a managed instance. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. managedInstanceName - the name of the managed instance. parameters - the requested managed instance resource state.
func (client ManagedInstancesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, managedInstanceName string, parameters ManagedInstance) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ManagedInstancesClient) CreateOrUpdateResponder(resp *http.Response) (result ManagedInstance, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ManagedInstancesClient) CreateOrUpdateSender(req *http.Request) (future ManagedInstancesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ManagedInstancesClient) Delete(ctx context.Context, resourceGroupName string, managedInstanceName string) (result ManagedInstancesDeleteFuture, err error)
Delete deletes a managed instance. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. managedInstanceName - the name of the managed instance.
func (client ManagedInstancesClient) DeletePreparer(ctx context.Context, resourceGroupName string, managedInstanceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ManagedInstancesClient) 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 ManagedInstancesClient) DeleteSender(req *http.Request) (future ManagedInstancesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ManagedInstancesClient) Get(ctx context.Context, resourceGroupName string, managedInstanceName string) (result ManagedInstance, err error)
Get gets a managed instance. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. managedInstanceName - the name of the managed instance.
func (client ManagedInstancesClient) GetPreparer(ctx context.Context, resourceGroupName string, managedInstanceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ManagedInstancesClient) GetResponder(resp *http.Response) (result ManagedInstance, 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 ManagedInstancesClient) List(ctx context.Context) (result ManagedInstanceListResultPage, err error)
List gets a list of all managed instances in the subscription.
func (client ManagedInstancesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ManagedInstanceListResultPage, err error)
ListByResourceGroup gets a list of managed instances in a resource group. Parameters: resourceGroupName - the 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 ManagedInstancesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ManagedInstanceListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ManagedInstancesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ManagedInstancesClient) ListByResourceGroupResponder(resp *http.Response) (result ManagedInstanceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ManagedInstancesClient) 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 ManagedInstancesClient) ListComplete(ctx context.Context) (result ManagedInstanceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client ManagedInstancesClient) ListResponder(resp *http.Response) (result ManagedInstanceListResult, 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 ManagedInstancesClient) Update(ctx context.Context, resourceGroupName string, managedInstanceName string, parameters ManagedInstanceUpdate) (result ManagedInstancesUpdateFuture, err error)
Update updates a managed instance. Parameters: resourceGroupName - the name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. managedInstanceName - the name of the managed instance. parameters - the requested managed instance resource state.
func (client ManagedInstancesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, managedInstanceName string, parameters ManagedInstanceUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ManagedInstancesClient) UpdateResponder(resp *http.Response) (result ManagedInstance, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ManagedInstancesClient) UpdateSender(req *http.Request) (future ManagedInstancesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ManagedInstancesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ManagedInstancesClient) (ManagedInstance, error)
}ManagedInstancesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ManagedInstancesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ManagedInstancesClient) (autorest.Response, error)
}ManagedInstancesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ManagedInstancesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ManagedInstancesClient) (ManagedInstance, error)
}ManagedInstancesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
ManagedServerCreateMode enumerates the values for managed server create mode.
const (
// ManagedServerCreateModeDefault ...
ManagedServerCreateModeDefault ManagedServerCreateMode = "Default"
// ManagedServerCreateModePointInTimeRestore ...
ManagedServerCreateModePointInTimeRestore ManagedServerCreateMode = "PointInTimeRestore"
)func PossibleManagedServerCreateModeValues() []ManagedServerCreateMode
PossibleManagedServerCreateModeValues returns an array of possible values for the ManagedServerCreateMode const type.
type MaxSizeCapability struct {
// Limit - READ-ONLY; The maximum size limit (see 'unit' for the units).
Limit *int32 `json:"limit,omitempty"`
// Unit - READ-ONLY; The units that the limit is expressed in. Possible values include: 'Megabytes', 'Gigabytes', 'Terabytes', 'Petabytes'
Unit MaxSizeUnits `json:"unit,omitempty"`
// Status - READ-ONLY; The status of the capability. Possible values include: 'CapabilityStatusVisible', 'CapabilityStatusAvailable', 'CapabilityStatusDefault', 'CapabilityStatusDisabled'
Status CapabilityStatus `json:"status,omitempty"`
// Reason - The reason for the capability not being available.
Reason *string `json:"reason,omitempty"`
}MaxSizeCapability the maximum size capability.
func (msc MaxSizeCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MaxSizeCapability.
MaxSizeUnits enumerates the values for max size units.
const (
// Gigabytes ...
Gigabytes MaxSizeUnits = "Gigabytes"
// Megabytes ...
Megabytes MaxSizeUnits = "Megabytes"
// Petabytes ...
Petabytes MaxSizeUnits = "Petabytes"
// Terabytes ...
Terabytes MaxSizeUnits = "Terabytes"
)func PossibleMaxSizeUnitsValues() []MaxSizeUnits
PossibleMaxSizeUnitsValues returns an array of possible values for the MaxSizeUnits const type.
type Metric struct {
// StartTime - READ-ONLY; The start time for the metric (ISO-8601 format).
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; The end time for the metric (ISO-8601 format).
EndTime *date.Time `json:"endTime,omitempty"`
// TimeGrain - READ-ONLY; The time step to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Unit - READ-ONLY; The unit of the metric. Possible values include: 'UnitTypeCount', 'UnitTypeBytes', 'UnitTypeSeconds', 'UnitTypePercent', 'UnitTypeCountPerSecond', 'UnitTypeBytesPerSecond'
Unit UnitType `json:"unit,omitempty"`
// Name - READ-ONLY; The name information for the metric.
Name *MetricName `json:"name,omitempty"`
// MetricValues - READ-ONLY; The metric values for the specified time window and timestep.
MetricValues *[]MetricValue `json:"metricValues,omitempty"`
}Metric database metrics.