README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/privatelinkresources
Documentation
The privatelinkresources
SDK allows for interaction with Azure Resource Manager 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/privatelinkresources"
Client Initialization
client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateLinkResourcesClient.Get
ctx := context.TODO()
id := privatelinkresources.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "privateLinkResourceName")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: PrivateLinkResourcesClient.List
ctx := context.TODO()
id := privatelinkresources.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
- type GetOperationResponse
- type ListCompleteResult
- type ListCustomPager
- type ListOperationResponse
- type PrivateLinkResource
- type PrivateLinkResourceId
- type PrivateLinkResourceOperationPredicate
- type PrivateLinkResourceProperties
- type PrivateLinkResourcesClient
- func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)
- func (c PrivateLinkResourcesClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)
- func (c PrivateLinkResourcesClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
- func (c PrivateLinkResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, ...) (result ListCompleteResult, err error)
- type WorkspaceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidatePrivateLinkResourceID ¶
func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID
func ValidateWorkspaceID ¶
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID
Types ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *PrivateLinkResource }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []PrivateLinkResource }
type ListCustomPager ¶ added in v0.20240628.1153531
func (*ListCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListCustomPager) NextPageLink() *odata.Link
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]PrivateLinkResource }
type PrivateLinkResource ¶
type PrivateLinkResource struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *PrivateLinkResourceProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type PrivateLinkResourceId ¶
type PrivateLinkResourceId struct { SubscriptionId string ResourceGroupName string WorkspaceName string PrivateLinkResourceName string }
PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource
func NewPrivateLinkResourceID ¶
func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, workspaceName string, privateLinkResourceName string) PrivateLinkResourceId
NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct
func ParsePrivateLinkResourceID ¶
func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId
func ParsePrivateLinkResourceIDInsensitively ¶
func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
ParsePrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a PrivateLinkResourceId note: this method should only be used for API response data and not user input
func (*PrivateLinkResourceId) FromParseResult ¶
func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
func (PrivateLinkResourceId) ID ¶
func (id PrivateLinkResourceId) ID() string
ID returns the formatted Private Link Resource ID
func (PrivateLinkResourceId) Segments ¶
func (id PrivateLinkResourceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Private Link Resource ID
func (PrivateLinkResourceId) String ¶
func (id PrivateLinkResourceId) String() string
String returns a human-readable description of this Private Link Resource ID
type PrivateLinkResourceOperationPredicate ¶
func (PrivateLinkResourceOperationPredicate) Matches ¶
func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
type PrivateLinkResourcesClient ¶
type PrivateLinkResourcesClient struct {
Client *resourcemanager.Client
}
func NewPrivateLinkResourcesClientWithBaseURI ¶
func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
func (PrivateLinkResourcesClient) Get ¶
func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)
Get ...
func (PrivateLinkResourcesClient) List ¶
func (c PrivateLinkResourcesClient) List(ctx context.Context, id WorkspaceId) (result ListOperationResponse, err error)
List ...
func (PrivateLinkResourcesClient) ListComplete ¶
func (c PrivateLinkResourcesClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (PrivateLinkResourcesClient) ListCompleteMatchingPredicate ¶
func (c PrivateLinkResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate PrivateLinkResourceOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
type WorkspaceId ¶
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) 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