managedinstancekeys

package
v0.20240903.1111904 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

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

The managedinstancekeys SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-08-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-08-01-preview/managedinstancekeys"

Client Initialization

client := managedinstancekeys.NewManagedInstanceKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedInstanceKeysClient.CreateOrUpdate

ctx := context.TODO()
id := managedinstancekeys.NewManagedInstanceKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "keyValue")

payload := managedinstancekeys.ManagedInstanceKey{
	// ...
}


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

Example Usage: ManagedInstanceKeysClient.Delete

ctx := context.TODO()
id := managedinstancekeys.NewManagedInstanceKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "keyValue")

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

Example Usage: ManagedInstanceKeysClient.Get

ctx := context.TODO()
id := managedinstancekeys.NewManagedInstanceKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedInstanceKeysClient.ListByInstance

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

// alternatively `client.ListByInstance(ctx, id, managedinstancekeys.DefaultListByInstanceOperationOptions())` can be used to do batched pagination
items, err := client.ListByInstanceComplete(ctx, id, managedinstancekeys.DefaultListByInstanceOperationOptions())
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 ValidateManagedInstanceKeyID

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

ValidateManagedInstanceKeyID checks that 'input' can be parsed as a Managed Instance Key ID

Types

type CreateOrUpdateOperationResponse

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

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        *ManagedInstanceKey
}

type ListByInstanceCompleteResult

type ListByInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedInstanceKey
}

type ListByInstanceCustomPager

type ListByInstanceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link

type ListByInstanceOperationOptions

type ListByInstanceOperationOptions struct {
	Filter *string
}

func DefaultListByInstanceOperationOptions

func DefaultListByInstanceOperationOptions() ListByInstanceOperationOptions

func (ListByInstanceOperationOptions) ToHeaders

func (ListByInstanceOperationOptions) ToOData

func (ListByInstanceOperationOptions) ToQuery

type ListByInstanceOperationResponse

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedInstanceKey
}

type ManagedInstanceKey

type ManagedInstanceKey struct {
	Id         *string                       `json:"id,omitempty"`
	Kind       *string                       `json:"kind,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *ManagedInstanceKeyProperties `json:"properties,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type ManagedInstanceKeyId

type ManagedInstanceKeyId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	KeyName             string
}

ManagedInstanceKeyId is a struct representing the Resource ID for a Managed Instance Key

func NewManagedInstanceKeyID

func NewManagedInstanceKeyID(subscriptionId string, resourceGroupName string, managedInstanceName string, keyName string) ManagedInstanceKeyId

NewManagedInstanceKeyID returns a new ManagedInstanceKeyId struct

func ParseManagedInstanceKeyID

func ParseManagedInstanceKeyID(input string) (*ManagedInstanceKeyId, error)

ParseManagedInstanceKeyID parses 'input' into a ManagedInstanceKeyId

func ParseManagedInstanceKeyIDInsensitively

func ParseManagedInstanceKeyIDInsensitively(input string) (*ManagedInstanceKeyId, error)

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

func (*ManagedInstanceKeyId) FromParseResult

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

func (ManagedInstanceKeyId) ID

func (id ManagedInstanceKeyId) ID() string

ID returns the formatted Managed Instance Key ID

func (ManagedInstanceKeyId) Segments

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

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

func (ManagedInstanceKeyId) String

func (id ManagedInstanceKeyId) String() string

String returns a human-readable description of this Managed Instance Key ID

type ManagedInstanceKeyOperationPredicate

type ManagedInstanceKeyOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (ManagedInstanceKeyOperationPredicate) Matches

type ManagedInstanceKeyProperties

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

func (*ManagedInstanceKeyProperties) GetCreationDateAsTime

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

func (*ManagedInstanceKeyProperties) SetCreationDateAsTime

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

type ManagedInstanceKeysClient

type ManagedInstanceKeysClient struct {
	Client *resourcemanager.Client
}

func NewManagedInstanceKeysClientWithBaseURI

func NewManagedInstanceKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedInstanceKeysClient, error)

func (ManagedInstanceKeysClient) CreateOrUpdate

CreateOrUpdate ...

func (ManagedInstanceKeysClient) CreateOrUpdateThenPoll

func (c ManagedInstanceKeysClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceKeyId, input ManagedInstanceKey) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedInstanceKeysClient) Delete

Delete ...

func (ManagedInstanceKeysClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedInstanceKeysClient) Get

Get ...

func (ManagedInstanceKeysClient) ListByInstance

ListByInstance ...

func (ManagedInstanceKeysClient) ListByInstanceComplete

ListByInstanceComplete retrieves all the results into a single object

func (ManagedInstanceKeysClient) ListByInstanceCompleteMatchingPredicate

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServerKeyType

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

func (*ServerKeyType) UnmarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL