synapselinkworkspaces

README

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

The synapselinkworkspaces 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/synapselinkworkspaces"

Client Initialization

client := synapselinkworkspaces.NewSynapseLinkWorkspacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SynapseLinkWorkspacesClient.ListByDatabase

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

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

Documentation

Index

• type ListByDatabaseCompleteResult
• type ListByDatabaseCustomPager
  • func (p *ListByDatabaseCustomPager) NextPageLink() *odata.Link
• type ListByDatabaseOperationResponse
• type SynapseLinkWorkspace
• type SynapseLinkWorkspaceInfoProperties
• type SynapseLinkWorkspaceOperationPredicate
  • func (p SynapseLinkWorkspaceOperationPredicate) Matches(input SynapseLinkWorkspace) bool
• type SynapseLinkWorkspaceProperties
• type SynapseLinkWorkspacesClient
  • func NewSynapseLinkWorkspacesClientWithBaseURI(sdkApi sdkEnv.Api) (*SynapseLinkWorkspacesClient, error)
  • func (c SynapseLinkWorkspacesClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c SynapseLinkWorkspacesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c SynapseLinkWorkspacesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)

Types

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SynapseLinkWorkspace
}

type ListByDatabaseCustomPager

type ListByDatabaseCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByDatabaseCustomPager) NextPageLink

func (p *ListByDatabaseCustomPager) NextPageLink() *odata.Link

type ListByDatabaseOperationResponse

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SynapseLinkWorkspace
}

type SynapseLinkWorkspace

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

type SynapseLinkWorkspaceInfoProperties

type SynapseLinkWorkspaceInfoProperties struct {
	LinkConnectionName *string `json:"linkConnectionName,omitempty"`
	WorkspaceId        *string `json:"workspaceId,omitempty"`
}

type SynapseLinkWorkspaceOperationPredicate

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

func (SynapseLinkWorkspaceOperationPredicate) Matches

func (p SynapseLinkWorkspaceOperationPredicate) Matches(input SynapseLinkWorkspace) bool

type SynapseLinkWorkspaceProperties

type SynapseLinkWorkspaceProperties struct {
	Workspaces *[]SynapseLinkWorkspaceInfoProperties `json:"workspaces,omitempty"`
}

type SynapseLinkWorkspacesClient

type SynapseLinkWorkspacesClient struct {
	Client *resourcemanager.Client
}

func NewSynapseLinkWorkspacesClientWithBaseURI

func NewSynapseLinkWorkspacesClientWithBaseURI(sdkApi sdkEnv.Api) (*SynapseLinkWorkspacesClient, error)

func (SynapseLinkWorkspacesClient) ListByDatabase

func (c SynapseLinkWorkspacesClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (SynapseLinkWorkspacesClient) ListByDatabaseComplete

func (c SynapseLinkWorkspacesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (SynapseLinkWorkspacesClient) ListByDatabaseCompleteMatchingPredicate

func (c SynapseLinkWorkspacesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, predicate SynapseLinkWorkspaceOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate