privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/search/2023-11-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service search (API Version 2023-11-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/search/2023-11-01/privatelinkresources"

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.ListSupported

ctx := context.TODO()
id := privatelinkresources.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

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

Documentation

Index

• func ValidateSearchServiceID(input interface{}, key string) (warnings []string, errors []error)
• type ListSupportedOperationOptions
  • func DefaultListSupportedOperationOptions() ListSupportedOperationOptions
  • func (o ListSupportedOperationOptions) ToHeaders() *client.Headers
  • func (o ListSupportedOperationOptions) ToOData() *odata.Query
  • func (o ListSupportedOperationOptions) ToQuery() *client.QueryParams
• type ListSupportedOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) ListSupported(ctx context.Context, id SearchServiceId, options ListSupportedOperationOptions) (result ListSupportedOperationResponse, err error)
• type PrivateLinkResourcesResult
• type SearchServiceId
  • func NewSearchServiceID(subscriptionId string, resourceGroupName string, searchServiceName string) SearchServiceId
  • func ParseSearchServiceID(input string) (*SearchServiceId, error)
  • func ParseSearchServiceIDInsensitively(input string) (*SearchServiceId, error)
  • func (id *SearchServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id SearchServiceId) ID() string
  • func (id SearchServiceId) Segments() []resourceids.Segment
  • func (id SearchServiceId) String() string
• type ShareablePrivateLinkResourceProperties
• type ShareablePrivateLinkResourceType

Functions

func ValidateSearchServiceID

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

ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID

Types

type ListSupportedOperationOptions

type ListSupportedOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultListSupportedOperationOptions

func DefaultListSupportedOperationOptions() ListSupportedOperationOptions

func (ListSupportedOperationOptions) ToHeaders

func (o ListSupportedOperationOptions) ToHeaders() *client.Headers

func (ListSupportedOperationOptions) ToOData

func (o ListSupportedOperationOptions) ToOData() *odata.Query

func (ListSupportedOperationOptions) ToQuery

func (o ListSupportedOperationOptions) ToQuery() *client.QueryParams

type ListSupportedOperationResponse

type ListSupportedOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResourcesResult
}

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 PrivateLinkResourceProperties

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

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) ListSupported

func (c PrivateLinkResourcesClient) ListSupported(ctx context.Context, id SearchServiceId, options ListSupportedOperationOptions) (result ListSupportedOperationResponse, err error)

ListSupported ...

type PrivateLinkResourcesResult

type PrivateLinkResourcesResult struct {
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

type SearchServiceId

type SearchServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
}

SearchServiceId is a struct representing the Resource ID for a Search Service

func NewSearchServiceID

func NewSearchServiceID(subscriptionId string, resourceGroupName string, searchServiceName string) SearchServiceId

NewSearchServiceID returns a new SearchServiceId struct

func ParseSearchServiceID

func ParseSearchServiceID(input string) (*SearchServiceId, error)

ParseSearchServiceID parses 'input' into a SearchServiceId

func ParseSearchServiceIDInsensitively

func ParseSearchServiceIDInsensitively(input string) (*SearchServiceId, error)

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

func (*SearchServiceId) FromParseResult

func (id *SearchServiceId) FromParseResult(input resourceids.ParseResult) error

func (SearchServiceId) ID

func (id SearchServiceId) ID() string

ID returns the formatted Search Service ID

func (SearchServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Search Service ID

func (SearchServiceId) String

func (id SearchServiceId) String() string

String returns a human-readable description of this Search Service ID

type ShareablePrivateLinkResourceProperties

type ShareablePrivateLinkResourceProperties struct {
	Description *string `json:"description,omitempty"`
	GroupId     *string `json:"groupId,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type ShareablePrivateLinkResourceType

type ShareablePrivateLinkResourceType struct {
	Name       *string                                 `json:"name,omitempty"`
	Properties *ShareablePrivateLinkResourceProperties `json:"properties,omitempty"`
}