README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/search/2023-11-01/sharedprivatelinkresources
Documentation
The sharedprivatelinkresources
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/sharedprivatelinkresources"
Client Initialization
client := sharedprivatelinkresources.NewSharedPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SharedPrivateLinkResourcesClient.CreateOrUpdate
ctx := context.TODO()
id := sharedprivatelinkresources.NewSharedPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "sharedPrivateLinkResourceValue")
payload := sharedprivatelinkresources.SharedPrivateLinkResource{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload, sharedprivatelinkresources.DefaultCreateOrUpdateOperationOptions()); err != nil {
// handle the error
}
Example Usage: SharedPrivateLinkResourcesClient.Delete
ctx := context.TODO()
id := sharedprivatelinkresources.NewSharedPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "sharedPrivateLinkResourceValue")
if err := client.DeleteThenPoll(ctx, id, sharedprivatelinkresources.DefaultDeleteOperationOptions()); err != nil {
// handle the error
}
Example Usage: SharedPrivateLinkResourcesClient.Get
ctx := context.TODO()
id := sharedprivatelinkresources.NewSharedPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "sharedPrivateLinkResourceValue")
read, err := client.Get(ctx, id, sharedprivatelinkresources.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SharedPrivateLinkResourcesClient.ListByService
ctx := context.TODO()
id := sharedprivatelinkresources.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")
// alternatively `client.ListByService(ctx, id, sharedprivatelinkresources.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, sharedprivatelinkresources.DefaultListByServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForSharedPrivateLinkResourceProvisioningState() []string
- func PossibleValuesForSharedPrivateLinkResourceStatus() []string
- func ValidateSearchServiceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateSharedPrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type SearchServiceId
- type SharedPrivateLinkResource
- type SharedPrivateLinkResourceId
- func NewSharedPrivateLinkResourceID(subscriptionId string, resourceGroupName string, searchServiceName string, ...) SharedPrivateLinkResourceId
- func ParseSharedPrivateLinkResourceID(input string) (*SharedPrivateLinkResourceId, error)
- func ParseSharedPrivateLinkResourceIDInsensitively(input string) (*SharedPrivateLinkResourceId, error)
- type SharedPrivateLinkResourceOperationPredicate
- type SharedPrivateLinkResourceProperties
- type SharedPrivateLinkResourceProvisioningState
- type SharedPrivateLinkResourceStatus
- type SharedPrivateLinkResourcesClient
- func (c SharedPrivateLinkResourcesClient) CreateOrUpdate(ctx context.Context, id SharedPrivateLinkResourceId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c SharedPrivateLinkResourcesClient) CreateOrUpdateThenPoll(ctx context.Context, id SharedPrivateLinkResourceId, ...) error
- func (c SharedPrivateLinkResourcesClient) Delete(ctx context.Context, id SharedPrivateLinkResourceId, ...) (result DeleteOperationResponse, err error)
- func (c SharedPrivateLinkResourcesClient) DeleteThenPoll(ctx context.Context, id SharedPrivateLinkResourceId, ...) error
- func (c SharedPrivateLinkResourcesClient) Get(ctx context.Context, id SharedPrivateLinkResourceId, ...) (result GetOperationResponse, err error)
- func (c SharedPrivateLinkResourcesClient) ListByService(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c SharedPrivateLinkResourcesClient) ListByServiceComplete(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c SharedPrivateLinkResourcesClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForSharedPrivateLinkResourceProvisioningState ¶
func PossibleValuesForSharedPrivateLinkResourceProvisioningState() []string
func PossibleValuesForSharedPrivateLinkResourceStatus ¶
func PossibleValuesForSharedPrivateLinkResourceStatus() []string
func ValidateSearchServiceID ¶
ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID
func ValidateSharedPrivateLinkResourceID ¶
func ValidateSharedPrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
ValidateSharedPrivateLinkResourceID checks that 'input' can be parsed as a Shared Private Link Resource ID
Types ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
XMsClientRequestId *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationOptions ¶
type DeleteOperationOptions struct {
XMsClientRequestId *string
}
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationOptions ¶
type GetOperationOptions struct {
XMsClientRequestId *string
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *SharedPrivateLinkResource }
type ListByServiceCompleteResult ¶
type ListByServiceCompleteResult struct { LatestHttpResponse *http.Response Items []SharedPrivateLinkResource }
type ListByServiceOperationOptions ¶
type ListByServiceOperationOptions struct {
XMsClientRequestId *string
}
func DefaultListByServiceOperationOptions ¶
func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
func (ListByServiceOperationOptions) ToHeaders ¶
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]SharedPrivateLinkResource }
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 ¶ added in v0.20231127.1171502
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 SharedPrivateLinkResource ¶
type SharedPrivateLinkResource struct {}
type SharedPrivateLinkResourceId ¶
type SharedPrivateLinkResourceId struct {}
SharedPrivateLinkResourceId is a struct representing the Resource ID for a Shared Private Link Resource
func NewSharedPrivateLinkResourceID ¶
func NewSharedPrivateLinkResourceID(subscriptionId string, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string) SharedPrivateLinkResourceId
NewSharedPrivateLinkResourceID returns a new SharedPrivateLinkResourceId struct
func ParseSharedPrivateLinkResourceID ¶
func ParseSharedPrivateLinkResourceID(input string) (*SharedPrivateLinkResourceId, error)
ParseSharedPrivateLinkResourceID parses 'input' into a SharedPrivateLinkResourceId
func ParseSharedPrivateLinkResourceIDInsensitively ¶
func ParseSharedPrivateLinkResourceIDInsensitively(input string) (*SharedPrivateLinkResourceId, error)
ParseSharedPrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a SharedPrivateLinkResourceId note: this method should only be used for API response data and not user input
func (*SharedPrivateLinkResourceId) FromParseResult ¶ added in v0.20231127.1171502
func (id *SharedPrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
func (SharedPrivateLinkResourceId) ID ¶
func (id SharedPrivateLinkResourceId) ID() string
ID returns the formatted Shared Private Link Resource ID
func (SharedPrivateLinkResourceId) Segments ¶
func (id SharedPrivateLinkResourceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Shared Private Link Resource ID
func (SharedPrivateLinkResourceId) String ¶
func (id SharedPrivateLinkResourceId) String() string
String returns a human-readable description of this Shared Private Link Resource ID
type SharedPrivateLinkResourceOperationPredicate ¶
type SharedPrivateLinkResourceOperationPredicate struct {}
func (SharedPrivateLinkResourceOperationPredicate) Matches ¶
func (p SharedPrivateLinkResourceOperationPredicate) Matches(input SharedPrivateLinkResource) bool
type SharedPrivateLinkResourceProperties ¶
type SharedPrivateLinkResourceProperties struct {}
type SharedPrivateLinkResourceProvisioningState ¶
type SharedPrivateLinkResourceProvisioningState string
const ()
func (*SharedPrivateLinkResourceProvisioningState) UnmarshalJSON ¶
func (s *SharedPrivateLinkResourceProvisioningState) UnmarshalJSON(bytes []byte) error
type SharedPrivateLinkResourceStatus ¶
type SharedPrivateLinkResourceStatus string
const ()
func (*SharedPrivateLinkResourceStatus) UnmarshalJSON ¶
func (s *SharedPrivateLinkResourceStatus) UnmarshalJSON(bytes []byte) error
type SharedPrivateLinkResourcesClient ¶
type SharedPrivateLinkResourcesClient struct {
}func NewSharedPrivateLinkResourcesClientWithBaseURI ¶
func NewSharedPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*SharedPrivateLinkResourcesClient, error)
func (SharedPrivateLinkResourcesClient) CreateOrUpdate ¶
func (c SharedPrivateLinkResourcesClient) CreateOrUpdate(ctx context.Context, id SharedPrivateLinkResourceId, input SharedPrivateLinkResource, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (SharedPrivateLinkResourcesClient) CreateOrUpdateThenPoll ¶
func (c SharedPrivateLinkResourcesClient) CreateOrUpdateThenPoll(ctx context.Context, id SharedPrivateLinkResourceId, input SharedPrivateLinkResource, options CreateOrUpdateOperationOptions) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (SharedPrivateLinkResourcesClient) Delete ¶
func (c SharedPrivateLinkResourcesClient) Delete(ctx context.Context, id SharedPrivateLinkResourceId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (SharedPrivateLinkResourcesClient) DeleteThenPoll ¶
func (c SharedPrivateLinkResourcesClient) DeleteThenPoll(ctx context.Context, id SharedPrivateLinkResourceId, options DeleteOperationOptions) error
DeleteThenPoll performs Delete then polls until it's completed
func (SharedPrivateLinkResourcesClient) Get ¶
func (c SharedPrivateLinkResourcesClient) Get(ctx context.Context, id SharedPrivateLinkResourceId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (SharedPrivateLinkResourcesClient) ListByService ¶
func (c SharedPrivateLinkResourcesClient) ListByService(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (SharedPrivateLinkResourcesClient) ListByServiceComplete ¶
func (c SharedPrivateLinkResourcesClient) ListByServiceComplete(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (SharedPrivateLinkResourcesClient) ListByServiceCompleteMatchingPredicate ¶
func (c SharedPrivateLinkResourcesClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, options ListByServiceOperationOptions, predicate SharedPrivateLinkResourceOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate