encryptionprotectors

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

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

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

Client Initialization

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

Example Usage: EncryptionProtectorsClient.CreateOrUpdate

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

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


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

Example Usage: EncryptionProtectorsClient.Get

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

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 := commonids.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName")

// 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 := commonids.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForServerKeyType

func PossibleValuesForServerKeyType() []string

Types

type CreateOrUpdateOperationResponse

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

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

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

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

Get ...

func (EncryptionProtectorsClient) ListByServer

ListByServer ...

func (EncryptionProtectorsClient) ListByServerComplete

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

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 {
	LatestHttpResponse *http.Response
	Items              []EncryptionProtector
}

type ListByServerCustomPager added in v0.20240628.1153531

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

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

Jump to

Keyboard shortcuts

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