elasticpooloperations

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/elasticpooloperations Documentation

The elasticpooloperations SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-01-preview).

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/sql/2023-02-01-preview/elasticpooloperations"

Client Initialization

client := elasticpooloperations.NewElasticPoolOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ElasticPoolOperationsClient.Cancel

ctx := context.TODO()
id := elasticpooloperations.NewOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "elasticPoolValue", "operationIdValue")

read, err := client.Cancel(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ElasticPoolOperationsClient.ListByElasticPool

ctx := context.TODO()
id := elasticpooloperations.NewSqlElasticPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "elasticPoolValue")

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

Documentation

Index

• func ValidateOperationID(input interface{}, key string) (warnings []string, errors []error)
• type CancelOperationResponse
• type ElasticPoolOperation
• type ElasticPoolOperationOperationPredicate
  • func (p ElasticPoolOperationOperationPredicate) Matches(input ElasticPoolOperation) bool
• type ElasticPoolOperationProperties
  • func (o *ElasticPoolOperationProperties) GetEstimatedCompletionTimeAsTime() (*time.Time, error)
  • func (o *ElasticPoolOperationProperties) GetStartTimeAsTime() (*time.Time, error)
  • func (o *ElasticPoolOperationProperties) SetEstimatedCompletionTimeAsTime(input time.Time)
  • func (o *ElasticPoolOperationProperties) SetStartTimeAsTime(input time.Time)
• type ElasticPoolOperationsClient
  • func NewElasticPoolOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticPoolOperationsClient, error)
  • func (c ElasticPoolOperationsClient) Cancel(ctx context.Context, id OperationId) (result CancelOperationResponse, err error)
  • func (c ElasticPoolOperationsClient) ListByElasticPool(ctx context.Context, id commonids.SqlElasticPoolId) (result ListByElasticPoolOperationResponse, err error)
  • func (c ElasticPoolOperationsClient) ListByElasticPoolComplete(ctx context.Context, id commonids.SqlElasticPoolId) (ListByElasticPoolCompleteResult, error)
  • func (c ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate(ctx context.Context, id commonids.SqlElasticPoolId, ...) (result ListByElasticPoolCompleteResult, err error)
• type ListByElasticPoolCompleteResult
• type ListByElasticPoolOperationResponse
• type OperationId
  • func NewOperationID(subscriptionId string, resourceGroupName string, serverName string, ...) OperationId
  • func ParseOperationID(input string) (*OperationId, error)
  • func ParseOperationIDInsensitively(input string) (*OperationId, error)
  • func (id OperationId) ID() string
  • func (id OperationId) Segments() []resourceids.Segment
  • func (id OperationId) String() string

Functions

func ValidateOperationID

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

Types

type CancelOperationResponse

type CancelOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ElasticPoolOperation

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

type ElasticPoolOperationOperationPredicate

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

func (ElasticPoolOperationOperationPredicate) Matches

func (p ElasticPoolOperationOperationPredicate) Matches(input ElasticPoolOperation) bool

type ElasticPoolOperationProperties

type ElasticPoolOperationProperties struct {
	Description             *string `json:"description,omitempty"`
	ElasticPoolName         *string `json:"elasticPoolName,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                   *string `json:"state,omitempty"`
}

func (*ElasticPoolOperationProperties) GetEstimatedCompletionTimeAsTime

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

func (*ElasticPoolOperationProperties) GetStartTimeAsTime

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

func (*ElasticPoolOperationProperties) SetEstimatedCompletionTimeAsTime

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

func (*ElasticPoolOperationProperties) SetStartTimeAsTime

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

type ElasticPoolOperationsClient

type ElasticPoolOperationsClient struct {
	Client *resourcemanager.Client
}

func NewElasticPoolOperationsClientWithBaseURI

func NewElasticPoolOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticPoolOperationsClient, error)

func (ElasticPoolOperationsClient) Cancel

func (c ElasticPoolOperationsClient) Cancel(ctx context.Context, id OperationId) (result CancelOperationResponse, err error)

Cancel ...

func (ElasticPoolOperationsClient) ListByElasticPool

func (c ElasticPoolOperationsClient) ListByElasticPool(ctx context.Context, id commonids.SqlElasticPoolId) (result ListByElasticPoolOperationResponse, err error)

ListByElasticPool ...

func (ElasticPoolOperationsClient) ListByElasticPoolComplete

func (c ElasticPoolOperationsClient) ListByElasticPoolComplete(ctx context.Context, id commonids.SqlElasticPoolId) (ListByElasticPoolCompleteResult, error)

ListByElasticPoolComplete retrieves all the results into a single object

func (ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate

func (c ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate(ctx context.Context, id commonids.SqlElasticPoolId, predicate ElasticPoolOperationOperationPredicate) (result ListByElasticPoolCompleteResult, err error)

ListByElasticPoolCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByElasticPoolCompleteResult

type ListByElasticPoolCompleteResult struct {
	Items []ElasticPoolOperation
}

type ListByElasticPoolOperationResponse

type ListByElasticPoolOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ElasticPoolOperation
}

type OperationId

type OperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	ElasticPoolName   string
	OperationId       string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID

func NewOperationID(subscriptionId string, resourceGroupName string, serverName string, elasticPoolName string, operationId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (OperationId) ID

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Operation ID

func (OperationId) String

func (id OperationId) String() string

String returns a human-readable description of this Operation ID