recoverablesqlpools

README

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

The recoverablesqlpools 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/recoverablesqlpools"

Client Initialization

client := recoverablesqlpools.NewRecoverableSqlPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoverableSqlPoolsClient.WorkspaceManagedSqlServerRecoverableSqlPoolsGet

ctx := context.TODO()
id := recoverablesqlpools.NewRecoverableSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "recoverableSqlPoolValue")

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

Example Usage: RecoverableSqlPoolsClient.WorkspaceManagedSqlServerRecoverableSqlPoolsList

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

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

Documentation

Index

• func ValidateRecoverableSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type RecoverableSqlPool
• type RecoverableSqlPoolId
  • func NewRecoverableSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, ...) RecoverableSqlPoolId
  • func ParseRecoverableSqlPoolID(input string) (*RecoverableSqlPoolId, error)
  • func ParseRecoverableSqlPoolIDInsensitively(input string) (*RecoverableSqlPoolId, error)
  • func (id *RecoverableSqlPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id RecoverableSqlPoolId) ID() string
  • func (id RecoverableSqlPoolId) Segments() []resourceids.Segment
  • func (id RecoverableSqlPoolId) String() string
• type RecoverableSqlPoolOperationPredicate
  • func (p RecoverableSqlPoolOperationPredicate) Matches(input RecoverableSqlPool) bool
• type RecoverableSqlPoolProperties
  • func (o *RecoverableSqlPoolProperties) GetLastAvailableBackupDateAsTime() (*time.Time, error)
  • func (o *RecoverableSqlPoolProperties) SetLastAvailableBackupDateAsTime(input time.Time)
• type RecoverableSqlPoolsClient
  • func NewRecoverableSqlPoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoverableSqlPoolsClient, error)
  • func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsGet(ctx context.Context, id RecoverableSqlPoolId) (result WorkspaceManagedSqlServerRecoverableSqlPoolsGetOperationResponse, ...)
  • func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsList(ctx context.Context, id WorkspaceId) (result WorkspaceManagedSqlServerRecoverableSqlPoolsListOperationResponse, ...)
  • func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListComplete(ctx context.Context, id WorkspaceId) (WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult, error)
  • func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, ...) (result WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult, ...)
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string
• type WorkspaceManagedSqlServerRecoverableSqlPoolsGetOperationResponse
• type WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult
• type WorkspaceManagedSqlServerRecoverableSqlPoolsListOperationResponse

Functions

func ValidateRecoverableSqlPoolID

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

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

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type RecoverableSqlPool

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

type RecoverableSqlPoolId

type RecoverableSqlPoolId struct {
	SubscriptionId         string
	ResourceGroupName      string
	WorkspaceName          string
	RecoverableSqlPoolName string
}

RecoverableSqlPoolId is a struct representing the Resource ID for a Recoverable Sql Pool

func NewRecoverableSqlPoolID

func NewRecoverableSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, recoverableSqlPoolName string) RecoverableSqlPoolId

NewRecoverableSqlPoolID returns a new RecoverableSqlPoolId struct

func ParseRecoverableSqlPoolID

func ParseRecoverableSqlPoolID(input string) (*RecoverableSqlPoolId, error)

ParseRecoverableSqlPoolID parses 'input' into a RecoverableSqlPoolId

func ParseRecoverableSqlPoolIDInsensitively

func ParseRecoverableSqlPoolIDInsensitively(input string) (*RecoverableSqlPoolId, error)

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

func (*RecoverableSqlPoolId) FromParseResult

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

func (RecoverableSqlPoolId) ID

func (id RecoverableSqlPoolId) ID() string

ID returns the formatted Recoverable Sql Pool ID

func (RecoverableSqlPoolId) Segments

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

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

func (RecoverableSqlPoolId) String

func (id RecoverableSqlPoolId) String() string

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

type RecoverableSqlPoolOperationPredicate

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

func (RecoverableSqlPoolOperationPredicate) Matches

func (p RecoverableSqlPoolOperationPredicate) Matches(input RecoverableSqlPool) bool

type RecoverableSqlPoolProperties

type RecoverableSqlPoolProperties struct {
	Edition                 *string `json:"edition,omitempty"`
	ElasticPoolName         *string `json:"elasticPoolName,omitempty"`
	LastAvailableBackupDate *string `json:"lastAvailableBackupDate,omitempty"`
	ServiceLevelObjective   *string `json:"serviceLevelObjective,omitempty"`
}

func (*RecoverableSqlPoolProperties) GetLastAvailableBackupDateAsTime

func (o *RecoverableSqlPoolProperties) GetLastAvailableBackupDateAsTime() (*time.Time, error)

func (*RecoverableSqlPoolProperties) SetLastAvailableBackupDateAsTime

func (o *RecoverableSqlPoolProperties) SetLastAvailableBackupDateAsTime(input time.Time)

type RecoverableSqlPoolsClient

type RecoverableSqlPoolsClient struct {
	Client *resourcemanager.Client
}

func NewRecoverableSqlPoolsClientWithBaseURI

func NewRecoverableSqlPoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoverableSqlPoolsClient, error)

func (RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsGet

func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsGet(ctx context.Context, id RecoverableSqlPoolId) (result WorkspaceManagedSqlServerRecoverableSqlPoolsGetOperationResponse, err error)

WorkspaceManagedSqlServerRecoverableSqlPoolsGet ...

func (RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsList

func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsList(ctx context.Context, id WorkspaceId) (result WorkspaceManagedSqlServerRecoverableSqlPoolsListOperationResponse, err error)

WorkspaceManagedSqlServerRecoverableSqlPoolsList ...

func (RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListComplete

func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListComplete(ctx context.Context, id WorkspaceId) (WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult, error)

WorkspaceManagedSqlServerRecoverableSqlPoolsListComplete retrieves all the results into a single object

func (RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteMatchingPredicate

func (c RecoverableSqlPoolsClient) WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate RecoverableSqlPoolOperationPredicate) (result WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult, err error)

WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult

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

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

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

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

type WorkspaceManagedSqlServerRecoverableSqlPoolsGetOperationResponse

type WorkspaceManagedSqlServerRecoverableSqlPoolsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecoverableSqlPool
}

type WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult

type WorkspaceManagedSqlServerRecoverableSqlPoolsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RecoverableSqlPool
}

type WorkspaceManagedSqlServerRecoverableSqlPoolsListOperationResponse

type WorkspaceManagedSqlServerRecoverableSqlPoolsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecoverableSqlPool
}