synapselinkworkspaces

README

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

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

Client Initialization

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

Example Usage: SynapseLinkWorkspacesClient.ListByDatabase

ctx := context.TODO()
id := synapselinkworkspaces.NewDatabaseID("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

• func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type DatabaseId
  • func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, ...) DatabaseId
  • func ParseDatabaseID(input string) (*DatabaseId, error)
  • func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)
  • func (id DatabaseId) ID() string
  • func (id DatabaseId) Segments() []resourceids.Segment
  • func (id DatabaseId) String() string
• type ListByDatabaseCompleteResult
• 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 DatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c SynapseLinkWorkspacesClient) ListByDatabaseComplete(ctx context.Context, id DatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c SynapseLinkWorkspacesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id DatabaseId, ...) (result ListByDatabaseCompleteResult, err error)

Functions

func ValidateDatabaseID

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

ValidateDatabaseID checks that 'input' can be parsed as a Database ID

Types

type DatabaseId

type DatabaseId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
}

DatabaseId is a struct representing the Resource ID for a Database

func NewDatabaseID

func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, databaseName string) DatabaseId

NewDatabaseID returns a new DatabaseId struct

func ParseDatabaseID

func ParseDatabaseID(input string) (*DatabaseId, error)

ParseDatabaseID parses 'input' into a DatabaseId

func ParseDatabaseIDInsensitively

func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)

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

func (DatabaseId) ID

func (id DatabaseId) ID() string

ID returns the formatted Database ID

func (DatabaseId) Segments

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

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

func (DatabaseId) String

func (id DatabaseId) String() string

String returns a human-readable description of this Database ID

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	Items []SynapseLinkWorkspace
}

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 DatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (SynapseLinkWorkspacesClient) ListByDatabaseComplete

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

ListByDatabaseComplete retrieves all the results into a single object

func (SynapseLinkWorkspacesClient) ListByDatabaseCompleteMatchingPredicate

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

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate