README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/search/2023-11-01/querykeys Documentation
The querykeys 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/querykeys"
Client Initialization
client := querykeys.NewQueryKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: QueryKeysClient.Create
ctx := context.TODO()
id := querykeys.NewCreateQueryKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "createQueryKeyValue")
read, err := client.Create(ctx, id, querykeys.DefaultCreateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: QueryKeysClient.Delete
ctx := context.TODO()
id := querykeys.NewDeleteQueryKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "deleteQueryKeyValue")
read, err := client.Delete(ctx, id, querykeys.DefaultDeleteOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: QueryKeysClient.ListBySearchService
ctx := context.TODO()
id := querykeys.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")
// alternatively `client.ListBySearchService(ctx, id, querykeys.DefaultListBySearchServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListBySearchServiceComplete(ctx, id, querykeys.DefaultListBySearchServiceOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation
¶
Index ¶
- func ValidateCreateQueryKeyID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateDeleteQueryKeyID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateSearchServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationOptions
- type CreateOperationResponse
- type CreateQueryKeyId
- type DeleteOperationOptions
- type DeleteOperationResponse
- type DeleteQueryKeyId
- type ListBySearchServiceCompleteResult
- type ListBySearchServiceOperationOptions
- type ListBySearchServiceOperationResponse
- type QueryKey
- type QueryKeyOperationPredicate
- type QueryKeysClient
- func (c QueryKeysClient) Create(ctx context.Context, id CreateQueryKeyId, options CreateOperationOptions) (result CreateOperationResponse, err error)
- func (c QueryKeysClient) Delete(ctx context.Context, id DeleteQueryKeyId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c QueryKeysClient) ListBySearchService(ctx context.Context, id SearchServiceId, ...) (result ListBySearchServiceOperationResponse, err error)
- func (c QueryKeysClient) ListBySearchServiceComplete(ctx context.Context, id SearchServiceId, ...) (ListBySearchServiceCompleteResult, error)
- func (c QueryKeysClient) ListBySearchServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, ...) (result ListBySearchServiceCompleteResult, err error)
- type SearchServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateCreateQueryKeyID ¶
ValidateCreateQueryKeyID checks that 'input' can be parsed as a Create Query Key ID
func ValidateDeleteQueryKeyID ¶
ValidateDeleteQueryKeyID checks that 'input' can be parsed as a Delete Query Key ID
func ValidateSearchServiceID ¶
ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID
Types ¶
type CreateOperationOptions ¶
type CreateOperationOptions struct {
XMsClientRequestId *string
}
func DefaultCreateOperationOptions ¶
func DefaultCreateOperationOptions() CreateOperationOptions
func (CreateOperationOptions) ToHeaders ¶
func (o CreateOperationOptions) ToHeaders() *client.Headers
func (CreateOperationOptions) ToOData ¶
func (o CreateOperationOptions) ToOData() *odata.Query
func (CreateOperationOptions) ToQuery ¶
func (o CreateOperationOptions) ToQuery() *client.QueryParams
type CreateOperationResponse ¶
type CreateQueryKeyId ¶
type CreateQueryKeyId struct {
SubscriptionId string
ResourceGroupName string
SearchServiceName string
CreateQueryKeyName string
}
CreateQueryKeyId is a struct representing the Resource ID for a Create Query Key
func NewCreateQueryKeyID ¶
func NewCreateQueryKeyID(subscriptionId string, resourceGroupName string, searchServiceName string, createQueryKeyName string) CreateQueryKeyId
NewCreateQueryKeyID returns a new CreateQueryKeyId struct
func ParseCreateQueryKeyID ¶
func ParseCreateQueryKeyID(input string) (*CreateQueryKeyId, error)
ParseCreateQueryKeyID parses 'input' into a CreateQueryKeyId
func ParseCreateQueryKeyIDInsensitively ¶
func ParseCreateQueryKeyIDInsensitively(input string) (*CreateQueryKeyId, error)
ParseCreateQueryKeyIDInsensitively parses 'input' case-insensitively into a CreateQueryKeyId note: this method should only be used for API response data and not user input
func (*CreateQueryKeyId) FromParseResult ¶
func (id *CreateQueryKeyId) FromParseResult(input resourceids.ParseResult) error
func (CreateQueryKeyId) ID ¶
func (id CreateQueryKeyId) ID() string
ID returns the formatted Create Query Key ID
func (CreateQueryKeyId) Segments ¶
func (id CreateQueryKeyId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Create Query Key ID
func (CreateQueryKeyId) String ¶
func (id CreateQueryKeyId) String() string
String returns a human-readable description of this Create Query Key ID
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 DeleteQueryKeyId ¶
type DeleteQueryKeyId struct {
SubscriptionId string
ResourceGroupName string
SearchServiceName string
DeleteQueryKeyName string
}
DeleteQueryKeyId is a struct representing the Resource ID for a Delete Query Key
func NewDeleteQueryKeyID ¶
func NewDeleteQueryKeyID(subscriptionId string, resourceGroupName string, searchServiceName string, deleteQueryKeyName string) DeleteQueryKeyId
NewDeleteQueryKeyID returns a new DeleteQueryKeyId struct
func ParseDeleteQueryKeyID ¶
func ParseDeleteQueryKeyID(input string) (*DeleteQueryKeyId, error)
ParseDeleteQueryKeyID parses 'input' into a DeleteQueryKeyId
func ParseDeleteQueryKeyIDInsensitively ¶
func ParseDeleteQueryKeyIDInsensitively(input string) (*DeleteQueryKeyId, error)
ParseDeleteQueryKeyIDInsensitively parses 'input' case-insensitively into a DeleteQueryKeyId note: this method should only be used for API response data and not user input
func (*DeleteQueryKeyId) FromParseResult ¶
func (id *DeleteQueryKeyId) FromParseResult(input resourceids.ParseResult) error
func (DeleteQueryKeyId) ID ¶
func (id DeleteQueryKeyId) ID() string
ID returns the formatted Delete Query Key ID
func (DeleteQueryKeyId) Segments ¶
func (id DeleteQueryKeyId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Delete Query Key ID
func (DeleteQueryKeyId) String ¶
func (id DeleteQueryKeyId) String() string
String returns a human-readable description of this Delete Query Key ID
type ListBySearchServiceOperationOptions ¶
type ListBySearchServiceOperationOptions struct {
XMsClientRequestId *string
}
func DefaultListBySearchServiceOperationOptions ¶
func DefaultListBySearchServiceOperationOptions() ListBySearchServiceOperationOptions
func (ListBySearchServiceOperationOptions) ToHeaders ¶
func (o ListBySearchServiceOperationOptions) ToHeaders() *client.Headers
func (ListBySearchServiceOperationOptions) ToOData ¶
func (o ListBySearchServiceOperationOptions) ToOData() *odata.Query
func (ListBySearchServiceOperationOptions) ToQuery ¶
func (o ListBySearchServiceOperationOptions) ToQuery() *client.QueryParams
type QueryKeyOperationPredicate ¶
func (QueryKeyOperationPredicate) Matches ¶
func (p QueryKeyOperationPredicate) Matches(input QueryKey) bool
type QueryKeysClient ¶
type QueryKeysClient struct {
Client *resourcemanager.Client
}
func NewQueryKeysClientWithBaseURI ¶
func NewQueryKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*QueryKeysClient, error)
func (QueryKeysClient) Create ¶
func (c QueryKeysClient) Create(ctx context.Context, id CreateQueryKeyId, options CreateOperationOptions) (result CreateOperationResponse, err error)
Create ...
func (QueryKeysClient) Delete ¶
func (c QueryKeysClient) Delete(ctx context.Context, id DeleteQueryKeyId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (QueryKeysClient) ListBySearchService ¶
func (c QueryKeysClient) ListBySearchService(ctx context.Context, id SearchServiceId, options ListBySearchServiceOperationOptions) (result ListBySearchServiceOperationResponse, err error)
ListBySearchService ...
func (QueryKeysClient) ListBySearchServiceComplete ¶
func (c QueryKeysClient) ListBySearchServiceComplete(ctx context.Context, id SearchServiceId, options ListBySearchServiceOperationOptions) (ListBySearchServiceCompleteResult, error)
ListBySearchServiceComplete retrieves all the results into a single object
func (QueryKeysClient) ListBySearchServiceCompleteMatchingPredicate ¶
func (c QueryKeysClient) ListBySearchServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, options ListBySearchServiceOperationOptions, predicate QueryKeyOperationPredicate) (result ListBySearchServiceCompleteResult, err error)
ListBySearchServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate
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
Source Files