serveroperations

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/serveroperations Documentation

The serveroperations SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2022-11-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/2022-11-01-preview/serveroperations"

Client Initialization

client := serveroperations.NewServerOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerOperationsClient.ListByServer

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

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

Documentation

Index

• func PossibleValuesForManagementOperationState() []string
• func ValidateServerID(input interface{}, key string) (warnings []string, errors []error)
• type ListByServerCompleteResult
• type ListByServerOperationResponse
• type ManagementOperationState
  • func (s *ManagementOperationState) UnmarshalJSON(bytes []byte) error
• type ServerId
  • func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId
  • func ParseServerID(input string) (*ServerId, error)
  • func ParseServerIDInsensitively(input string) (*ServerId, error)
  • func (id ServerId) ID() string
  • func (id ServerId) Segments() []resourceids.Segment
  • func (id ServerId) String() string
• type ServerOperation
• type ServerOperationOperationPredicate
  • func (p ServerOperationOperationPredicate) Matches(input ServerOperation) bool
• type ServerOperationProperties
  • func (o *ServerOperationProperties) GetEstimatedCompletionTimeAsTime() (*time.Time, error)
  • func (o *ServerOperationProperties) GetStartTimeAsTime() (*time.Time, error)
  • func (o *ServerOperationProperties) SetEstimatedCompletionTimeAsTime(input time.Time)
  • func (o *ServerOperationProperties) SetStartTimeAsTime(input time.Time)
• type ServerOperationsClient
  • func NewServerOperationsClientWithBaseURI(api environments.Api) (*ServerOperationsClient, error)
  • func (c ServerOperationsClient) ListByServer(ctx context.Context, id ServerId) (result ListByServerOperationResponse, err error)
  • func (c ServerOperationsClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)
  • func (c ServerOperationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate ServerOperationOperationPredicate) (result ListByServerCompleteResult, err error)

Functions

func PossibleValuesForManagementOperationState

func PossibleValuesForManagementOperationState() []string

func ValidateServerID

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

ValidateServerID checks that 'input' can be parsed as a Server ID

Types

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []ServerOperation
}

type ListByServerOperationResponse

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerOperation
}

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 ServerId

type ServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID

func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId

NewServerID returns a new ServerId struct

func ParseServerID

func ParseServerID(input string) (*ServerId, error)

ParseServerID parses 'input' into a ServerId

func ParseServerIDInsensitively

func ParseServerIDInsensitively(input string) (*ServerId, error)

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

func (ServerId) ID

func (id ServerId) ID() string

ID returns the formatted Server ID

func (ServerId) Segments

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

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

func (ServerId) String

func (id ServerId) String() string

String returns a human-readable description of this Server ID

type ServerOperation

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

type ServerOperationOperationPredicate

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

func (ServerOperationOperationPredicate) Matches

func (p ServerOperationOperationPredicate) Matches(input ServerOperation) bool

type ServerOperationProperties

type ServerOperationProperties struct {
	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 (*ServerOperationProperties) GetEstimatedCompletionTimeAsTime

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

func (*ServerOperationProperties) GetStartTimeAsTime

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

func (*ServerOperationProperties) SetEstimatedCompletionTimeAsTime

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

func (*ServerOperationProperties) SetStartTimeAsTime

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

type ServerOperationsClient

type ServerOperationsClient struct {
	Client *resourcemanager.Client
}

func NewServerOperationsClientWithBaseURI

func NewServerOperationsClientWithBaseURI(api environments.Api) (*ServerOperationsClient, error)

func (ServerOperationsClient) ListByServer

func (c ServerOperationsClient) ListByServer(ctx context.Context, id ServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (ServerOperationsClient) ListByServerComplete

func (c ServerOperationsClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (ServerOperationsClient) ListByServerCompleteMatchingPredicate

func (c ServerOperationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate ServerOperationOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate