elasticpooloperations

README

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

The elasticpooloperations SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2021-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/2021-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.NewElasticPoolOperationID("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.NewElasticPoolID("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 ValidateElasticPoolID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateElasticPoolOperationID(input interface{}, key string) (warnings []string, errors []error)
• type CancelOperationResponse
• type ElasticPoolId
  • func NewElasticPoolID(subscriptionId string, resourceGroupName string, serverName string, ...) ElasticPoolId
  • func ParseElasticPoolID(input string) (*ElasticPoolId, error)
  • func ParseElasticPoolIDInsensitively(input string) (*ElasticPoolId, error)
  • func (id ElasticPoolId) ID() string
  • func (id ElasticPoolId) Segments() []resourceids.Segment
  • func (id ElasticPoolId) String() string
• type ElasticPoolOperation
• type ElasticPoolOperationId
  • func NewElasticPoolOperationID(subscriptionId string, resourceGroupName string, serverName string, ...) ElasticPoolOperationId
  • func ParseElasticPoolOperationID(input string) (*ElasticPoolOperationId, error)
  • func ParseElasticPoolOperationIDInsensitively(input string) (*ElasticPoolOperationId, error)
  • func (id ElasticPoolOperationId) ID() string
  • func (id ElasticPoolOperationId) Segments() []resourceids.Segment
  • func (id ElasticPoolOperationId) String() string
• 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 ElasticPoolOperationId) (result CancelOperationResponse, err error)
  • func (c ElasticPoolOperationsClient) ListByElasticPool(ctx context.Context, id ElasticPoolId) (result ListByElasticPoolOperationResponse, err error)
  • func (c ElasticPoolOperationsClient) ListByElasticPoolComplete(ctx context.Context, id ElasticPoolId) (ListByElasticPoolCompleteResult, error)
  • func (c ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate(ctx context.Context, id ElasticPoolId, ...) (result ListByElasticPoolCompleteResult, err error)
• type ListByElasticPoolCompleteResult
• type ListByElasticPoolOperationResponse

Functions

func ValidateElasticPoolID

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

ValidateElasticPoolID checks that 'input' can be parsed as a Elastic Pool ID

func ValidateElasticPoolOperationID

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

ValidateElasticPoolOperationID checks that 'input' can be parsed as a Elastic Pool Operation ID

Types

type CancelOperationResponse

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

type ElasticPoolId

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

ElasticPoolId is a struct representing the Resource ID for a Elastic Pool

func NewElasticPoolID

func NewElasticPoolID(subscriptionId string, resourceGroupName string, serverName string, elasticPoolName string) ElasticPoolId

NewElasticPoolID returns a new ElasticPoolId struct

func ParseElasticPoolID

func ParseElasticPoolID(input string) (*ElasticPoolId, error)

ParseElasticPoolID parses 'input' into a ElasticPoolId

func ParseElasticPoolIDInsensitively

func ParseElasticPoolIDInsensitively(input string) (*ElasticPoolId, error)

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

func (ElasticPoolId) ID

func (id ElasticPoolId) ID() string

ID returns the formatted Elastic Pool ID

func (ElasticPoolId) Segments

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

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

func (ElasticPoolId) String

func (id ElasticPoolId) String() string

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

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 ElasticPoolOperationId

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

ElasticPoolOperationId is a struct representing the Resource ID for a Elastic Pool Operation

func NewElasticPoolOperationID

func NewElasticPoolOperationID(subscriptionId string, resourceGroupName string, serverName string, elasticPoolName string, operationId string) ElasticPoolOperationId

NewElasticPoolOperationID returns a new ElasticPoolOperationId struct

func ParseElasticPoolOperationID

func ParseElasticPoolOperationID(input string) (*ElasticPoolOperationId, error)

ParseElasticPoolOperationID parses 'input' into a ElasticPoolOperationId

func ParseElasticPoolOperationIDInsensitively

func ParseElasticPoolOperationIDInsensitively(input string) (*ElasticPoolOperationId, error)

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

func (ElasticPoolOperationId) ID

func (id ElasticPoolOperationId) ID() string

ID returns the formatted Elastic Pool Operation ID

func (ElasticPoolOperationId) Segments

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

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

func (ElasticPoolOperationId) String

func (id ElasticPoolOperationId) String() string

String returns a human-readable description of this Elastic Pool Operation ID

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 ElasticPoolOperationId) (result CancelOperationResponse, err error)

Cancel ...

func (ElasticPoolOperationsClient) ListByElasticPool

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

ListByElasticPool ...

func (ElasticPoolOperationsClient) ListByElasticPoolComplete

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

ListByElasticPoolComplete retrieves all the results into a single object

func (ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate

func (c ElasticPoolOperationsClient) ListByElasticPoolCompleteMatchingPredicate(ctx context.Context, id ElasticPoolId, 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
}