serverkeys

package
v0.20240325.1135512 Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/serverkeys Documentation

The serverkeys SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-01-preview).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/serverkeys"

Client Initialization

client := serverkeys.NewServerKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerKeysClient.CreateOrUpdate

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

payload := serverkeys.ServerKey{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ServerKeysClient.Delete

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ServerKeysClient.Get

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

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

Example Usage: ServerKeysClient.ListByServer

ctx := context.TODO()
id := commonids.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue")

// alternatively `client.ListByServer(ctx, id)` can be used to do batched pagination
items, err := client.ListByServerComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForServerKeyType 

func PossibleValuesForServerKeyType() []string

func ValidateKeyID 

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

ValidateKeyID checks that 'input' can be parsed as a Key ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerKey
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerKey
}

type KeyId 

type KeyId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	KeyName           string
}

KeyId is a struct representing the Resource ID for a Key

func NewKeyID 

func NewKeyID(subscriptionId string, resourceGroupName string, serverName string, keyName string) KeyId

NewKeyID returns a new KeyId struct

func ParseKeyID 

func ParseKeyID(input string) (*KeyId, error)

ParseKeyID parses 'input' into a KeyId

func ParseKeyIDInsensitively 

func ParseKeyIDInsensitively(input string) (*KeyId, error)

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

func (*KeyId) FromParseResult 

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

func (KeyId) ID 

func (id KeyId) ID() string

ID returns the formatted Key ID

func (KeyId) Segments 

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

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

func (KeyId) String 

func (id KeyId) String() string

String returns a human-readable description of this Key ID

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerKey
}

type ListByServerOperationResponse 

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerKey
}

type ServerKey 

type ServerKey struct {
	Id         *string              `json:"id,omitempty"`
	Kind       *string              `json:"kind,omitempty"`
	Location   *string              `json:"location,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *ServerKeyProperties `json:"properties,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type ServerKeyOperationPredicate 

type ServerKeyOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (ServerKeyOperationPredicate) Matches 

func (p ServerKeyOperationPredicate) Matches(input ServerKey) bool

type ServerKeyProperties 

type ServerKeyProperties struct {
	AutoRotationEnabled *bool         `json:"autoRotationEnabled,omitempty"`
	CreationDate        *string       `json:"creationDate,omitempty"`
	ServerKeyType       ServerKeyType `json:"serverKeyType"`
	Subregion           *string       `json:"subregion,omitempty"`
	Thumbprint          *string       `json:"thumbprint,omitempty"`
	Uri                 *string       `json:"uri,omitempty"`
}

func (*ServerKeyProperties) GetCreationDateAsTime 

func (o *ServerKeyProperties) GetCreationDateAsTime() (*time.Time, error)

func (*ServerKeyProperties) SetCreationDateAsTime 

func (o *ServerKeyProperties) SetCreationDateAsTime(input time.Time)

type ServerKeyType 

type ServerKeyType string
const (
	ServerKeyTypeAzureKeyVault  ServerKeyType = "AzureKeyVault"
	ServerKeyTypeServiceManaged ServerKeyType = "ServiceManaged"
)

func (*ServerKeyType) UnmarshalJSON 

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

type ServerKeysClient 

type ServerKeysClient struct {
	Client *resourcemanager.Client
}

func NewServerKeysClientWithBaseURI 

func NewServerKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerKeysClient, error)

func (ServerKeysClient) CreateOrUpdate 

func (c ServerKeysClient) CreateOrUpdate(ctx context.Context, id KeyId, input ServerKey) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerKeysClient) CreateOrUpdateThenPoll 

func (c ServerKeysClient) CreateOrUpdateThenPoll(ctx context.Context, id KeyId, input ServerKey) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerKeysClient) Delete 

func (c ServerKeysClient) Delete(ctx context.Context, id KeyId) (result DeleteOperationResponse, err error)

Delete ...

func (ServerKeysClient) DeleteThenPoll 

func (c ServerKeysClient) DeleteThenPoll(ctx context.Context, id KeyId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServerKeysClient) Get 

func (c ServerKeysClient) Get(ctx context.Context, id KeyId) (result GetOperationResponse, err error)

Get ...

func (ServerKeysClient) ListByServer 

func (c ServerKeysClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (ServerKeysClient) ListByServerComplete 

func (c ServerKeysClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (ServerKeysClient) ListByServerCompleteMatchingPredicate 

func (c ServerKeysClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate ServerKeyOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.