workspacemanagedsqlserver

README

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

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

Client Initialization

client := workspacemanagedsqlserver.NewWorkspaceManagedSqlServerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkspaceManagedSqlServerClient.RecoverableSqlPoolsGet

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

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

Example Usage: WorkspaceManagedSqlServerClient.RecoverableSqlPoolsList

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

// alternatively `client.RecoverableSqlPoolsList(ctx, id)` can be used to do batched pagination
items, err := client.RecoverableSqlPoolsListComplete(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 RecoverableSqlPoolsGetOperationResponse
• type RecoverableSqlPoolsListCompleteResult
• type RecoverableSqlPoolsListOperationResponse
• 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 WorkspaceManagedSqlServerClient
  • func NewWorkspaceManagedSqlServerClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceManagedSqlServerClient, error)
  • func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsGet(ctx context.Context, id RecoverableSqlPoolId) (result RecoverableSqlPoolsGetOperationResponse, err error)
  • func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsList(ctx context.Context, id WorkspaceId) (result RecoverableSqlPoolsListOperationResponse, err error)
  • func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListComplete(ctx context.Context, id WorkspaceId) (RecoverableSqlPoolsListCompleteResult, error)
  • func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, ...) (result RecoverableSqlPoolsListCompleteResult, err error)

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 RecoverableSqlPoolsGetOperationResponse

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

type RecoverableSqlPoolsListCompleteResult

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

type RecoverableSqlPoolsListOperationResponse

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

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 WorkspaceManagedSqlServerClient

type WorkspaceManagedSqlServerClient struct {
	Client *resourcemanager.Client
}

func NewWorkspaceManagedSqlServerClientWithBaseURI

func NewWorkspaceManagedSqlServerClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkspaceManagedSqlServerClient, error)

func (WorkspaceManagedSqlServerClient) RecoverableSqlPoolsGet

func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsGet(ctx context.Context, id RecoverableSqlPoolId) (result RecoverableSqlPoolsGetOperationResponse, err error)

RecoverableSqlPoolsGet ...

func (WorkspaceManagedSqlServerClient) RecoverableSqlPoolsList

func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsList(ctx context.Context, id WorkspaceId) (result RecoverableSqlPoolsListOperationResponse, err error)

RecoverableSqlPoolsList ...

func (WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListComplete

func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListComplete(ctx context.Context, id WorkspaceId) (RecoverableSqlPoolsListCompleteResult, error)

RecoverableSqlPoolsListComplete retrieves all the results into a single object

func (WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListCompleteMatchingPredicate

func (c WorkspaceManagedSqlServerClient) RecoverableSqlPoolsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate RecoverableSqlPoolOperationPredicate) (result RecoverableSqlPoolsListCompleteResult, err error)

RecoverableSqlPoolsListCompleteMatchingPredicate retrieves all the results and then applies the predicate