Documentation ¶
Overview ¶
Package sql implements the Azure ARM Sql service API version 2017-10-01-preview.
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.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type DatabaseOperation
- type DatabaseOperationListResult
- type DatabaseOperationListResultIterator
- type DatabaseOperationListResultPage
- type DatabaseOperationProperties
- type DatabaseOperationsClient
- func (client DatabaseOperationsClient) Cancel(ctx context.Context, resourceGroupName string, serverName string, ...) (result autorest.Response, err error)
- func (client DatabaseOperationsClient) CancelPreparer(ctx context.Context, resourceGroupName string, serverName string, ...) (*http.Request, error)
- func (client DatabaseOperationsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseOperationsClient) CancelSender(req *http.Request) (*http.Response, error)
- func (client DatabaseOperationsClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, ...) (result DatabaseOperationListResultPage, err error)
- func (client DatabaseOperationsClient) ListByDatabaseComplete(ctx context.Context, resourceGroupName string, serverName string, ...) (result DatabaseOperationListResultIterator, err error)
- func (client DatabaseOperationsClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, ...) (*http.Request, error)
- func (client DatabaseOperationsClient) ListByDatabaseResponder(resp *http.Response) (result DatabaseOperationListResult, err error)
- func (client DatabaseOperationsClient) ListByDatabaseSender(req *http.Request) (*http.Response, error)
- type ElasticPoolOperation
- type ElasticPoolOperationListResult
- type ElasticPoolOperationListResultIterator
- func (iter *ElasticPoolOperationListResultIterator) Next() error
- func (iter ElasticPoolOperationListResultIterator) NotDone() bool
- func (iter ElasticPoolOperationListResultIterator) Response() ElasticPoolOperationListResult
- func (iter ElasticPoolOperationListResultIterator) Value() ElasticPoolOperation
- type ElasticPoolOperationListResultPage
- type ElasticPoolOperationProperties
- type ElasticPoolOperationsClient
- func (client ElasticPoolOperationsClient) Cancel(ctx context.Context, resourceGroupName string, serverName string, ...) (result autorest.Response, err error)
- func (client ElasticPoolOperationsClient) CancelPreparer(ctx context.Context, resourceGroupName string, serverName string, ...) (*http.Request, error)
- func (client ElasticPoolOperationsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ElasticPoolOperationsClient) CancelSender(req *http.Request) (*http.Response, error)
- func (client ElasticPoolOperationsClient) ListByElasticPool(ctx context.Context, resourceGroupName string, serverName string, ...) (result ElasticPoolOperationListResultPage, err error)
- func (client ElasticPoolOperationsClient) ListByElasticPoolComplete(ctx context.Context, resourceGroupName string, serverName string, ...) (result ElasticPoolOperationListResultIterator, err error)
- func (client ElasticPoolOperationsClient) ListByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, ...) (*http.Request, error)
- func (client ElasticPoolOperationsClient) ListByElasticPoolResponder(resp *http.Response) (result ElasticPoolOperationListResult, err error)
- func (client ElasticPoolOperationsClient) ListByElasticPoolSender(req *http.Request) (*http.Response, error)
- type ManagementOperationState
- type ProxyResource
- type Resource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Sql
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Sql.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type DatabaseOperation ¶
type DatabaseOperation struct { // DatabaseOperationProperties - Resource properties. *DatabaseOperationProperties `json:"properties,omitempty"` // ID - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` }
DatabaseOperation a database operation.
func (DatabaseOperation) MarshalJSON ¶
func (do DatabaseOperation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseOperation.
func (*DatabaseOperation) UnmarshalJSON ¶
func (do *DatabaseOperation) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseOperation struct.
type DatabaseOperationListResult ¶
type DatabaseOperationListResult struct { autorest.Response `json:"-"` // Value - Array of results. Value *[]DatabaseOperation `json:"value,omitempty"` // NextLink - Link to retrieve next page of results. NextLink *string `json:"nextLink,omitempty"` }
DatabaseOperationListResult the response to a list database operations request
func (DatabaseOperationListResult) IsEmpty ¶
func (dolr DatabaseOperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DatabaseOperationListResultIterator ¶
type DatabaseOperationListResultIterator struct {
// contains filtered or unexported fields
}
DatabaseOperationListResultIterator provides access to a complete listing of DatabaseOperation values.
func (*DatabaseOperationListResultIterator) Next ¶
func (iter *DatabaseOperationListResultIterator) 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.
func (DatabaseOperationListResultIterator) NotDone ¶
func (iter DatabaseOperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (DatabaseOperationListResultIterator) Response ¶
func (iter DatabaseOperationListResultIterator) Response() DatabaseOperationListResult
Response returns the raw server response from the last page request.
func (DatabaseOperationListResultIterator) Value ¶
func (iter DatabaseOperationListResultIterator) Value() DatabaseOperation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DatabaseOperationListResultPage ¶
type DatabaseOperationListResultPage struct {
// contains filtered or unexported fields
}
DatabaseOperationListResultPage contains a page of DatabaseOperation values.
func (*DatabaseOperationListResultPage) Next ¶
func (page *DatabaseOperationListResultPage) 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.
func (DatabaseOperationListResultPage) NotDone ¶
func (page DatabaseOperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (DatabaseOperationListResultPage) Response ¶
func (page DatabaseOperationListResultPage) Response() DatabaseOperationListResult
Response returns the raw server response from the last page request.
func (DatabaseOperationListResultPage) Values ¶
func (page DatabaseOperationListResultPage) Values() []DatabaseOperation
Values returns the slice of values for the current page or nil if there are no values.
type DatabaseOperationProperties ¶
type DatabaseOperationProperties struct { // DatabaseName - The name of the database the operation is being performed on. DatabaseName *string `json:"databaseName,omitempty"` // Operation - The name of operation. Operation *string `json:"operation,omitempty"` // OperationFriendlyName - The friendly name of operation. OperationFriendlyName *string `json:"operationFriendlyName,omitempty"` // PercentComplete - The percentage of the operation completed. PercentComplete *int32 `json:"percentComplete,omitempty"` // ServerName - The name of the server. ServerName *string `json:"serverName,omitempty"` // StartTime - The operation start time. StartTime *date.Time `json:"startTime,omitempty"` // State - The operation state. Possible values include: 'Pending', 'InProgress', 'Succeeded', 'Failed', 'CancelInProgress', 'Cancelled' State ManagementOperationState `json:"state,omitempty"` // ErrorCode - The operation error code. ErrorCode *int32 `json:"errorCode,omitempty"` // ErrorDescription - The operation error description. ErrorDescription *string `json:"errorDescription,omitempty"` // ErrorSeverity - The operation error severity. ErrorSeverity *int32 `json:"errorSeverity,omitempty"` // IsUserError - Whether or not the error is a user error. IsUserError *bool `json:"isUserError,omitempty"` // EstimatedCompletionTime - The estimated completion time of the operation. EstimatedCompletionTime *date.Time `json:"estimatedCompletionTime,omitempty"` // Description - The operation description. Description *string `json:"description,omitempty"` // IsCancellable - Whether the operation can be cancelled. IsCancellable *bool `json:"isCancellable,omitempty"` }
DatabaseOperationProperties the properties of a database operation.
type DatabaseOperationsClient ¶
type DatabaseOperationsClient struct {
BaseClient
}
DatabaseOperationsClient 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 NewDatabaseOperationsClient ¶
func NewDatabaseOperationsClient(subscriptionID string) DatabaseOperationsClient
NewDatabaseOperationsClient creates an instance of the DatabaseOperationsClient client.
func NewDatabaseOperationsClientWithBaseURI ¶
func NewDatabaseOperationsClientWithBaseURI(baseURI string, subscriptionID string) DatabaseOperationsClient
NewDatabaseOperationsClientWithBaseURI creates an instance of the DatabaseOperationsClient client.
func (DatabaseOperationsClient) Cancel ¶
func (client DatabaseOperationsClient) Cancel(ctx context.Context, resourceGroupName string, serverName string, databaseName string, operationID uuid.UUID) (result autorest.Response, err error)
Cancel cancels the asynchronous operation on the database.
resourceGroupName is 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 is the name of the server. databaseName is the name of the database. operationID is the operation identifier.
func (DatabaseOperationsClient) CancelPreparer ¶
func (client DatabaseOperationsClient) CancelPreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string, operationID uuid.UUID) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (DatabaseOperationsClient) CancelResponder ¶
func (client DatabaseOperationsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (DatabaseOperationsClient) CancelSender ¶
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (DatabaseOperationsClient) ListByDatabase ¶
func (client DatabaseOperationsClient) ListByDatabase(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseOperationListResultPage, err error)
ListByDatabase gets a list of operations performed on the database.
resourceGroupName is 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 is the name of the server. databaseName is the name of the database.
func (DatabaseOperationsClient) ListByDatabaseComplete ¶
func (client DatabaseOperationsClient) ListByDatabaseComplete(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (result DatabaseOperationListResultIterator, err error)
ListByDatabaseComplete enumerates all values, automatically crossing page boundaries as required.
func (DatabaseOperationsClient) ListByDatabasePreparer ¶
func (client DatabaseOperationsClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, serverName string, databaseName string) (*http.Request, error)
ListByDatabasePreparer prepares the ListByDatabase request.
func (DatabaseOperationsClient) ListByDatabaseResponder ¶
func (client DatabaseOperationsClient) ListByDatabaseResponder(resp *http.Response) (result DatabaseOperationListResult, err error)
ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.
func (DatabaseOperationsClient) ListByDatabaseSender ¶
func (client DatabaseOperationsClient) 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 ElasticPoolOperation ¶
type ElasticPoolOperation struct { // ElasticPoolOperationProperties - Resource properties. *ElasticPoolOperationProperties `json:"properties,omitempty"` // ID - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` }
ElasticPoolOperation a elastic pool operation.
func (ElasticPoolOperation) MarshalJSON ¶
func (epo ElasticPoolOperation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ElasticPoolOperation.
func (*ElasticPoolOperation) UnmarshalJSON ¶
func (epo *ElasticPoolOperation) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ElasticPoolOperation struct.
type ElasticPoolOperationListResult ¶
type ElasticPoolOperationListResult struct { autorest.Response `json:"-"` // Value - Array of results. Value *[]ElasticPoolOperation `json:"value,omitempty"` // NextLink - Link to retrieve next page of results. NextLink *string `json:"nextLink,omitempty"` }
ElasticPoolOperationListResult the response to a list elastic pool operations request
func (ElasticPoolOperationListResult) IsEmpty ¶
func (epolr ElasticPoolOperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ElasticPoolOperationListResultIterator ¶
type ElasticPoolOperationListResultIterator struct {
// contains filtered or unexported fields
}
ElasticPoolOperationListResultIterator provides access to a complete listing of ElasticPoolOperation values.
func (*ElasticPoolOperationListResultIterator) Next ¶
func (iter *ElasticPoolOperationListResultIterator) 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.
func (ElasticPoolOperationListResultIterator) NotDone ¶
func (iter ElasticPoolOperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ElasticPoolOperationListResultIterator) Response ¶
func (iter ElasticPoolOperationListResultIterator) Response() ElasticPoolOperationListResult
Response returns the raw server response from the last page request.
func (ElasticPoolOperationListResultIterator) Value ¶
func (iter ElasticPoolOperationListResultIterator) Value() ElasticPoolOperation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ElasticPoolOperationListResultPage ¶
type ElasticPoolOperationListResultPage struct {
// contains filtered or unexported fields
}
ElasticPoolOperationListResultPage contains a page of ElasticPoolOperation values.
func (*ElasticPoolOperationListResultPage) Next ¶
func (page *ElasticPoolOperationListResultPage) 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.
func (ElasticPoolOperationListResultPage) NotDone ¶
func (page ElasticPoolOperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ElasticPoolOperationListResultPage) Response ¶
func (page ElasticPoolOperationListResultPage) Response() ElasticPoolOperationListResult
Response returns the raw server response from the last page request.
func (ElasticPoolOperationListResultPage) Values ¶
func (page ElasticPoolOperationListResultPage) Values() []ElasticPoolOperation
Values returns the slice of values for the current page or nil if there are no values.
type ElasticPoolOperationProperties ¶
type ElasticPoolOperationProperties struct { // ElasticPoolName - The name of the elastic pool the operation is being performed on. ElasticPoolName *string `json:"elasticPoolName,omitempty"` // Operation - The name of operation. Operation *string `json:"operation,omitempty"` // OperationFriendlyName - The friendly name of operation. OperationFriendlyName *string `json:"operationFriendlyName,omitempty"` // PercentComplete - The percentage of the operation completed. PercentComplete *int32 `json:"percentComplete,omitempty"` // ServerName - The name of the server. ServerName *string `json:"serverName,omitempty"` // StartTime - The operation start time. StartTime *date.Time `json:"startTime,omitempty"` // State - The operation state. State *string `json:"state,omitempty"` // ErrorCode - The operation error code. ErrorCode *int32 `json:"errorCode,omitempty"` // ErrorDescription - The operation error description. ErrorDescription *string `json:"errorDescription,omitempty"` // ErrorSeverity - The operation error severity. ErrorSeverity *int32 `json:"errorSeverity,omitempty"` // IsUserError - Whether or not the error is a user error. IsUserError *bool `json:"isUserError,omitempty"` // EstimatedCompletionTime - The estimated completion time of the operation. EstimatedCompletionTime *date.Time `json:"estimatedCompletionTime,omitempty"` // Description - The operation description. Description *string `json:"description,omitempty"` // IsCancellable - Whether the operation can be cancelled. IsCancellable *bool `json:"isCancellable,omitempty"` }
ElasticPoolOperationProperties the properties of a elastic pool operation.
type ElasticPoolOperationsClient ¶
type ElasticPoolOperationsClient struct {
BaseClient
}
ElasticPoolOperationsClient 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 NewElasticPoolOperationsClient ¶
func NewElasticPoolOperationsClient(subscriptionID string) ElasticPoolOperationsClient
NewElasticPoolOperationsClient creates an instance of the ElasticPoolOperationsClient client.
func NewElasticPoolOperationsClientWithBaseURI ¶
func NewElasticPoolOperationsClientWithBaseURI(baseURI string, subscriptionID string) ElasticPoolOperationsClient
NewElasticPoolOperationsClientWithBaseURI creates an instance of the ElasticPoolOperationsClient client.
func (ElasticPoolOperationsClient) Cancel ¶
func (client ElasticPoolOperationsClient) Cancel(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, operationID uuid.UUID) (result autorest.Response, err error)
Cancel cancels the asynchronous operation on the elastic pool.
resourceGroupName is 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 is the name of the server. operationID is the operation identifier.
func (ElasticPoolOperationsClient) CancelPreparer ¶
func (client ElasticPoolOperationsClient) CancelPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string, operationID uuid.UUID) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (ElasticPoolOperationsClient) CancelResponder ¶
func (client ElasticPoolOperationsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (ElasticPoolOperationsClient) CancelSender ¶
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (ElasticPoolOperationsClient) ListByElasticPool ¶
func (client ElasticPoolOperationsClient) ListByElasticPool(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result ElasticPoolOperationListResultPage, err error)
ListByElasticPool gets a list of operations performed on the elastic pool.
resourceGroupName is 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 is the name of the server.
func (ElasticPoolOperationsClient) ListByElasticPoolComplete ¶
func (client ElasticPoolOperationsClient) ListByElasticPoolComplete(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (result ElasticPoolOperationListResultIterator, err error)
ListByElasticPoolComplete enumerates all values, automatically crossing page boundaries as required.
func (ElasticPoolOperationsClient) ListByElasticPoolPreparer ¶
func (client ElasticPoolOperationsClient) ListByElasticPoolPreparer(ctx context.Context, resourceGroupName string, serverName string, elasticPoolName string) (*http.Request, error)
ListByElasticPoolPreparer prepares the ListByElasticPool request.
func (ElasticPoolOperationsClient) ListByElasticPoolResponder ¶
func (client ElasticPoolOperationsClient) ListByElasticPoolResponder(resp *http.Response) (result ElasticPoolOperationListResult, err error)
ListByElasticPoolResponder handles the response to the ListByElasticPool request. The method always closes the http.Response Body.
func (ElasticPoolOperationsClient) ListByElasticPoolSender ¶
func (client ElasticPoolOperationsClient) 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 ManagementOperationState ¶
type ManagementOperationState string
ManagementOperationState enumerates the values for management operation state.
const ( // CancelInProgress ... CancelInProgress ManagementOperationState = "CancelInProgress" // Cancelled ... Cancelled ManagementOperationState = "Cancelled" // Failed ... Failed ManagementOperationState = "Failed" // InProgress ... InProgress ManagementOperationState = "InProgress" // Pending ... Pending ManagementOperationState = "Pending" // Succeeded ... Succeeded ManagementOperationState = "Succeeded" )
func PossibleManagementOperationStateValues ¶
func PossibleManagementOperationStateValues() []ManagementOperationState
PossibleManagementOperationStateValues returns an array of possible values for the ManagementOperationState const type.
type ProxyResource ¶
type ProxyResource struct { // ID - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` }
ProxyResource ARM proxy resource.