encryptionprotectors

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2021-11-01/encryptionprotectors Documentation

The encryptionprotectors SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2021-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/sql/2021-11-01/encryptionprotectors"

Client Initialization

client := encryptionprotectors.NewEncryptionProtectorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EncryptionProtectorsClient.CreateOrUpdate

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

payload := encryptionprotectors.EncryptionProtector{
	// ...
}


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

Example Usage: EncryptionProtectorsClient.Get

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

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: EncryptionProtectorsClient.ListByServer

ctx := context.TODO()
id := encryptionprotectors.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
}

Example Usage: EncryptionProtectorsClient.Revalidate

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

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

Documentation

Index

• func PossibleValuesForServerKeyType() []string
• type CreateOrUpdateOperationResponse
• type EncryptionProtector
• type EncryptionProtectorOperationPredicate
  • func (p EncryptionProtectorOperationPredicate) Matches(input EncryptionProtector) bool
• type EncryptionProtectorProperties
• type EncryptionProtectorsClient
  • func NewEncryptionProtectorsClientWithBaseURI(sdkApi sdkEnv.Api) (*EncryptionProtectorsClient, error)
  • func (c EncryptionProtectorsClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input EncryptionProtector) (result CreateOrUpdateOperationResponse, err error)
  • func (c EncryptionProtectorsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input EncryptionProtector) error
  • func (c EncryptionProtectorsClient) Get(ctx context.Context, id commonids.SqlServerId) (result GetOperationResponse, err error)
  • func (c EncryptionProtectorsClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)
  • func (c EncryptionProtectorsClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)
  • func (c EncryptionProtectorsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, ...) (result ListByServerCompleteResult, err error)
  • func (c EncryptionProtectorsClient) Revalidate(ctx context.Context, id commonids.SqlServerId) (result RevalidateOperationResponse, err error)
  • func (c EncryptionProtectorsClient) RevalidateThenPoll(ctx context.Context, id commonids.SqlServerId) error
• type GetOperationResponse
• type ListByServerCompleteResult
• type ListByServerOperationResponse
• type RevalidateOperationResponse
• type ServerKeyType
  • func (s *ServerKeyType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForServerKeyType

func PossibleValuesForServerKeyType() []string

Types

type CreateOrUpdateOperationResponse

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

type EncryptionProtector

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

type EncryptionProtectorOperationPredicate

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

func (EncryptionProtectorOperationPredicate) Matches

func (p EncryptionProtectorOperationPredicate) Matches(input EncryptionProtector) bool

type EncryptionProtectorProperties

type EncryptionProtectorProperties struct {
	AutoRotationEnabled *bool         `json:"autoRotationEnabled,omitempty"`
	ServerKeyName       *string       `json:"serverKeyName,omitempty"`
	ServerKeyType       ServerKeyType `json:"serverKeyType"`
	Subregion           *string       `json:"subregion,omitempty"`
	Thumbprint          *string       `json:"thumbprint,omitempty"`
	Uri                 *string       `json:"uri,omitempty"`
}

type EncryptionProtectorsClient

type EncryptionProtectorsClient struct {
	Client *resourcemanager.Client
}

func NewEncryptionProtectorsClientWithBaseURI

func NewEncryptionProtectorsClientWithBaseURI(sdkApi sdkEnv.Api) (*EncryptionProtectorsClient, error)

func (EncryptionProtectorsClient) CreateOrUpdate

func (c EncryptionProtectorsClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input EncryptionProtector) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (EncryptionProtectorsClient) CreateOrUpdateThenPoll

func (c EncryptionProtectorsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input EncryptionProtector) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (EncryptionProtectorsClient) Get

func (c EncryptionProtectorsClient) Get(ctx context.Context, id commonids.SqlServerId) (result GetOperationResponse, err error)

Get ...

func (EncryptionProtectorsClient) ListByServer

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

ListByServer ...

func (EncryptionProtectorsClient) ListByServerComplete

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

ListByServerComplete retrieves all the results into a single object

func (EncryptionProtectorsClient) ListByServerCompleteMatchingPredicate

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

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EncryptionProtectorsClient) Revalidate

func (c EncryptionProtectorsClient) Revalidate(ctx context.Context, id commonids.SqlServerId) (result RevalidateOperationResponse, err error)

Revalidate ...

func (EncryptionProtectorsClient) RevalidateThenPoll

func (c EncryptionProtectorsClient) RevalidateThenPoll(ctx context.Context, id commonids.SqlServerId) error

RevalidateThenPoll performs Revalidate then polls until it's completed

type GetOperationResponse

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

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []EncryptionProtector
}

type ListByServerOperationResponse

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

type RevalidateOperationResponse

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

type ServerKeyType

type ServerKeyType string

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

func (*ServerKeyType) UnmarshalJSON

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