README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/search/2023-11-01/adminkeys Documentation
The adminkeys 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/adminkeys"
Client Initialization
client := adminkeys.NewAdminKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AdminKeysClient.Get
ctx := context.TODO()
id := adminkeys.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")
read, err := client.Get(ctx, id, adminkeys.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AdminKeysClient.Regenerate
ctx := context.TODO()
id := adminkeys.NewKeyKindID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue", "primary")
read, err := client.Regenerate(ctx, id, adminkeys.DefaultRegenerateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation
¶
Index ¶
- func PossibleValuesForAdminKeyKind() []string
- func ValidateKeyKindID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateSearchServiceID(input interface{}, key string) (warnings []string, errors []error)
- type AdminKeyKind
- type AdminKeyResult
- type AdminKeysClient
- type GetOperationOptions
- type GetOperationResponse
- type KeyKindId
- type RegenerateOperationOptions
- type RegenerateOperationResponse
- type SearchServiceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForAdminKeyKind ¶
func PossibleValuesForAdminKeyKind() []string
func ValidateKeyKindID ¶
ValidateKeyKindID checks that 'input' can be parsed as a Key Kind ID
func ValidateSearchServiceID ¶
ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID
Types ¶
type AdminKeyKind ¶
type AdminKeyKind string
const ( AdminKeyKindPrimary AdminKeyKind = "primary" AdminKeyKindSecondary AdminKeyKind = "secondary" )
func (*AdminKeyKind) UnmarshalJSON ¶
func (s *AdminKeyKind) UnmarshalJSON(bytes []byte) error
type AdminKeyResult ¶
type AdminKeysClient ¶
type AdminKeysClient struct {
Client *resourcemanager.Client
}
func NewAdminKeysClientWithBaseURI ¶
func NewAdminKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*AdminKeysClient, error)
func (AdminKeysClient) Get ¶
func (c AdminKeysClient) Get(ctx context.Context, id SearchServiceId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (AdminKeysClient) Regenerate ¶
func (c AdminKeysClient) Regenerate(ctx context.Context, id KeyKindId, options RegenerateOperationOptions) (result RegenerateOperationResponse, err error)
Regenerate ...
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 *AdminKeyResult
}
type KeyKindId ¶
type KeyKindId struct {
SubscriptionId string
ResourceGroupName string
SearchServiceName string
KeyKind AdminKeyKind
}
KeyKindId is a struct representing the Resource ID for a Key Kind
func NewKeyKindID ¶
func NewKeyKindID(subscriptionId string, resourceGroupName string, searchServiceName string, keyKind AdminKeyKind) KeyKindId
NewKeyKindID returns a new KeyKindId struct
func ParseKeyKindID ¶
ParseKeyKindID parses 'input' into a KeyKindId
func ParseKeyKindIDInsensitively ¶
ParseKeyKindIDInsensitively parses 'input' case-insensitively into a KeyKindId note: this method should only be used for API response data and not user input
func (*KeyKindId) FromParseResult ¶
func (id *KeyKindId) FromParseResult(input resourceids.ParseResult) error
func (KeyKindId) Segments ¶
func (id KeyKindId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Key Kind ID
type RegenerateOperationOptions ¶
type RegenerateOperationOptions struct {
XMsClientRequestId *string
}
func DefaultRegenerateOperationOptions ¶
func DefaultRegenerateOperationOptions() RegenerateOperationOptions
func (RegenerateOperationOptions) ToHeaders ¶
func (o RegenerateOperationOptions) ToHeaders() *client.Headers
func (RegenerateOperationOptions) ToOData ¶
func (o RegenerateOperationOptions) ToOData() *odata.Query
func (RegenerateOperationOptions) ToQuery ¶
func (o RegenerateOperationOptions) ToQuery() *client.QueryParams
type RegenerateOperationResponse ¶
type RegenerateOperationResponse struct {
HttpResponse *http.Response
OData *odata.OData
Model *AdminKeyResult
}
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