sqlpoolsoperations

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsoperations Documentation

The sqlpoolsoperations SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsoperations"

Client Initialization

client := sqlpoolsoperations.NewSqlPoolsOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsOperationsClient.SqlPoolOperationsList

ctx := context.TODO()
id := sqlpoolsoperations.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

// alternatively `client.SqlPoolOperationsList(ctx, id)` can be used to do batched pagination
items, err := client.SqlPoolOperationsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForManagementOperationState() []string
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type ManagementOperationState
  • func (s *ManagementOperationState) UnmarshalJSON(bytes []byte) error
• type SqlPoolId
  • func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, ...) SqlPoolId
  • func ParseSqlPoolID(input string) (*SqlPoolId, error)
  • func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)
  • func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id SqlPoolId) ID() string
  • func (id SqlPoolId) Segments() []resourceids.Segment
  • func (id SqlPoolId) String() string
• type SqlPoolOperation
• type SqlPoolOperationOperationPredicate
  • func (p SqlPoolOperationOperationPredicate) Matches(input SqlPoolOperation) bool
• type SqlPoolOperationProperties
  • func (o *SqlPoolOperationProperties) GetEstimatedCompletionTimeAsTime() (*time.Time, error)
  • func (o *SqlPoolOperationProperties) GetStartTimeAsTime() (*time.Time, error)
  • func (o *SqlPoolOperationProperties) SetEstimatedCompletionTimeAsTime(input time.Time)
  • func (o *SqlPoolOperationProperties) SetStartTimeAsTime(input time.Time)
• type SqlPoolOperationsListCompleteResult
• type SqlPoolOperationsListOperationResponse
• type SqlPoolsOperationsClient
  • func NewSqlPoolsOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsOperationsClient, error)
  • func (c SqlPoolsOperationsClient) SqlPoolOperationsList(ctx context.Context, id SqlPoolId) (result SqlPoolOperationsListOperationResponse, err error)
  • func (c SqlPoolsOperationsClient) SqlPoolOperationsListComplete(ctx context.Context, id SqlPoolId) (SqlPoolOperationsListCompleteResult, error)
  • func (c SqlPoolsOperationsClient) SqlPoolOperationsListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, ...) (result SqlPoolOperationsListCompleteResult, err error)

Functions

func PossibleValuesForManagementOperationState

func PossibleValuesForManagementOperationState() []string

func ValidateSqlPoolID

func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)

ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID

Types

type ManagementOperationState

type ManagementOperationState string

const (
	ManagementOperationStateCancelInProgress ManagementOperationState = "CancelInProgress"
	ManagementOperationStateCancelled        ManagementOperationState = "Cancelled"
	ManagementOperationStateFailed           ManagementOperationState = "Failed"
	ManagementOperationStateInProgress       ManagementOperationState = "InProgress"
	ManagementOperationStatePending          ManagementOperationState = "Pending"
	ManagementOperationStateSucceeded        ManagementOperationState = "Succeeded"
)

func (*ManagementOperationState) UnmarshalJSON

func (s *ManagementOperationState) UnmarshalJSON(bytes []byte) error

type SqlPoolId

type SqlPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
}

SqlPoolId is a struct representing the Resource ID for a Sql Pool

func NewSqlPoolID

func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string) SqlPoolId

NewSqlPoolID returns a new SqlPoolId struct

func ParseSqlPoolID

func ParseSqlPoolID(input string) (*SqlPoolId, error)

ParseSqlPoolID parses 'input' into a SqlPoolId

func ParseSqlPoolIDInsensitively

func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)

ParseSqlPoolIDInsensitively parses 'input' case-insensitively into a SqlPoolId note: this method should only be used for API response data and not user input

func (*SqlPoolId) FromParseResult

func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error

func (SqlPoolId) ID

func (id SqlPoolId) ID() string

ID returns the formatted Sql Pool ID

func (SqlPoolId) Segments

func (id SqlPoolId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Sql Pool ID

func (SqlPoolId) String

func (id SqlPoolId) String() string

String returns a human-readable description of this Sql Pool ID

type SqlPoolOperation

type SqlPoolOperation struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *SqlPoolOperationProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type SqlPoolOperationOperationPredicate

type SqlPoolOperationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (SqlPoolOperationOperationPredicate) Matches

func (p SqlPoolOperationOperationPredicate) Matches(input SqlPoolOperation) bool

type SqlPoolOperationProperties

type SqlPoolOperationProperties struct {
	DatabaseName            *string                   `json:"databaseName,omitempty"`
	Description             *string                   `json:"description,omitempty"`
	ErrorCode               *int64                    `json:"errorCode,omitempty"`
	ErrorDescription        *string                   `json:"errorDescription,omitempty"`
	ErrorSeverity           *int64                    `json:"errorSeverity,omitempty"`
	EstimatedCompletionTime *string                   `json:"estimatedCompletionTime,omitempty"`
	IsCancellable           *bool                     `json:"isCancellable,omitempty"`
	IsUserError             *bool                     `json:"isUserError,omitempty"`
	Operation               *string                   `json:"operation,omitempty"`
	OperationFriendlyName   *string                   `json:"operationFriendlyName,omitempty"`
	PercentComplete         *int64                    `json:"percentComplete,omitempty"`
	ServerName              *string                   `json:"serverName,omitempty"`
	StartTime               *string                   `json:"startTime,omitempty"`
	State                   *ManagementOperationState `json:"state,omitempty"`
}

func (*SqlPoolOperationProperties) GetEstimatedCompletionTimeAsTime

func (o *SqlPoolOperationProperties) GetEstimatedCompletionTimeAsTime() (*time.Time, error)

func (*SqlPoolOperationProperties) GetStartTimeAsTime

func (o *SqlPoolOperationProperties) GetStartTimeAsTime() (*time.Time, error)

func (*SqlPoolOperationProperties) SetEstimatedCompletionTimeAsTime

func (o *SqlPoolOperationProperties) SetEstimatedCompletionTimeAsTime(input time.Time)

func (*SqlPoolOperationProperties) SetStartTimeAsTime

func (o *SqlPoolOperationProperties) SetStartTimeAsTime(input time.Time)

type SqlPoolOperationsListCompleteResult

type SqlPoolOperationsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SqlPoolOperation
}

type SqlPoolOperationsListOperationResponse

type SqlPoolOperationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SqlPoolOperation
}

type SqlPoolsOperationsClient

type SqlPoolsOperationsClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsOperationsClientWithBaseURI

func NewSqlPoolsOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsOperationsClient, error)

func (SqlPoolsOperationsClient) SqlPoolOperationsList

func (c SqlPoolsOperationsClient) SqlPoolOperationsList(ctx context.Context, id SqlPoolId) (result SqlPoolOperationsListOperationResponse, err error)

SqlPoolOperationsList ...

func (SqlPoolsOperationsClient) SqlPoolOperationsListComplete

func (c SqlPoolsOperationsClient) SqlPoolOperationsListComplete(ctx context.Context, id SqlPoolId) (SqlPoolOperationsListCompleteResult, error)

SqlPoolOperationsListComplete retrieves all the results into a single object

func (SqlPoolsOperationsClient) SqlPoolOperationsListCompleteMatchingPredicate

func (c SqlPoolsOperationsClient) SqlPoolOperationsListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate SqlPoolOperationOperationPredicate) (result SqlPoolOperationsListCompleteResult, err error)

SqlPoolOperationsListCompleteMatchingPredicate retrieves all the results and then applies the predicate