adminkeys

package
v0.20240112.1120540 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 12, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/search/2022-09-01/adminkeys Documentation

The adminkeys SDK allows for interaction with the Azure Resource Manager Service search (API Version 2022-09-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/2022-09-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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAdminKeyKind 

func PossibleValuesForAdminKeyKind() []string

func ValidateKeyKindID 

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

ValidateKeyKindID checks that 'input' can be parsed as a Key Kind ID

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 AdminKeyKind 

type AdminKeyKind string
const (
	AdminKeyKindPrimary   AdminKeyKind = "primary"
	AdminKeyKindSecondary AdminKeyKind = "secondary"
)

func (*AdminKeyKind) UnmarshalJSON added in v0.20230504.1071847 

func (s *AdminKeyKind) UnmarshalJSON(bytes []byte) error

type AdminKeyResult 

type AdminKeyResult struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

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 added in v0.20230504.1071847 

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

func (GetOperationOptions) ToOData added in v0.20230504.1071847 

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

func (GetOperationOptions) ToQuery added in v0.20230504.1071847 

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 

func ParseKeyKindID(input string) (*KeyKindId, error)

ParseKeyKindID parses 'input' into a KeyKindId

func ParseKeyKindIDInsensitively 

func ParseKeyKindIDInsensitively(input string) (*KeyKindId, error)

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 added in v0.20231127.1171502 

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

func (KeyKindId) ID 

func (id KeyKindId) ID() string

ID returns the formatted Key Kind ID

func (KeyKindId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Key Kind ID

func (KeyKindId) String 

func (id KeyKindId) String() string

String returns a human-readable description of this Key Kind ID

type RegenerateOperationOptions 

type RegenerateOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultRegenerateOperationOptions 

func DefaultRegenerateOperationOptions() RegenerateOperationOptions

func (RegenerateOperationOptions) ToHeaders added in v0.20230504.1071847 

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

func (RegenerateOperationOptions) ToOData added in v0.20230504.1071847 

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

func (RegenerateOperationOptions) ToQuery added in v0.20230504.1071847 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.