privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/databricks/2023-02-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service databricks (API Version 2023-02-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/databricks/2023-02-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", "workspaceValue", "groupIdValue")

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", "workspaceValue")

// 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 GroupIdInformation
• type GroupIdInformationOperationPredicate
  • func (p GroupIdInformationOperationPredicate) Matches(input GroupIdInformation) bool
• type GroupIdInformationProperties
• type ListCompleteResult
• type ListOperationResponse
• type PrivateLinkResourceId
  • func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, workspaceName string, ...) PrivateLinkResourceId
  • func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
  • func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
  • func (id PrivateLinkResourceId) ID() string
  • func (id PrivateLinkResourceId) Segments() []resourceids.Segment
  • func (id PrivateLinkResourceId) String() string
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(api environments.Api) (*PrivateLinkResourcesClient, error)
  • 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
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

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

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

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

Types

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupIdInformation
}

type GroupIdInformation

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

type GroupIdInformationOperationPredicate

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

func (GroupIdInformationOperationPredicate) Matches

func (p GroupIdInformationOperationPredicate) Matches(input GroupIdInformation) bool

type GroupIdInformationProperties

type GroupIdInformationProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []GroupIdInformation
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GroupIdInformation
}

type PrivateLinkResourceId

type PrivateLinkResourceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	GroupId           string
}

PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, workspaceName string, groupId 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) 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 PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(api environments.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 GroupIdInformationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate 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) 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