serverconfigurationoptions

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/serverconfigurationoptions Documentation

The serverconfigurationoptions SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2022-11-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-sdk/resource-manager/sql/2022-11-01-preview/serverconfigurationoptions"

Client Initialization

client := serverconfigurationoptions.NewServerConfigurationOptionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerConfigurationOptionsClient.CreateOrUpdate

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

payload := serverconfigurationoptions.ServerConfigurationOption{
	// ...
}


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

Example Usage: ServerConfigurationOptionsClient.Get

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

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: ServerConfigurationOptionsClient.ListByManagedInstance

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

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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateManagedInstanceID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByManagedInstanceCompleteResult
• type ListByManagedInstanceOperationResponse
• type ManagedInstanceId
  • func NewManagedInstanceID(subscriptionId string, resourceGroupName string, managedInstanceName string) ManagedInstanceId
  • func ParseManagedInstanceID(input string) (*ManagedInstanceId, error)
  • func ParseManagedInstanceIDInsensitively(input string) (*ManagedInstanceId, error)
  • func (id ManagedInstanceId) ID() string
  • func (id ManagedInstanceId) Segments() []resourceids.Segment
  • func (id ManagedInstanceId) String() string
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type ServerConfigurationOption
• type ServerConfigurationOptionOperationPredicate
  • func (p ServerConfigurationOptionOperationPredicate) Matches(input ServerConfigurationOption) bool
• type ServerConfigurationOptionProperties
• type ServerConfigurationOptionsClient
  • func NewServerConfigurationOptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerConfigurationOptionsClient, error)
  • func (c ServerConfigurationOptionsClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceId, input ServerConfigurationOption) (result CreateOrUpdateOperationResponse, err error)
  • func (c ServerConfigurationOptionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceId, input ServerConfigurationOption) error
  • func (c ServerConfigurationOptionsClient) Get(ctx context.Context, id ManagedInstanceId) (result GetOperationResponse, err error)
  • func (c ServerConfigurationOptionsClient) ListByManagedInstance(ctx context.Context, id ManagedInstanceId) (result ListByManagedInstanceOperationResponse, err error)
  • func (c ServerConfigurationOptionsClient) ListByManagedInstanceComplete(ctx context.Context, id ManagedInstanceId) (ListByManagedInstanceCompleteResult, error)
  • func (c ServerConfigurationOptionsClient) ListByManagedInstanceCompleteMatchingPredicate(ctx context.Context, id ManagedInstanceId, ...) (result ListByManagedInstanceCompleteResult, err error)

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateManagedInstanceID

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

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

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByManagedInstanceCompleteResult

type ListByManagedInstanceCompleteResult struct {
	Items []ServerConfigurationOption
}

type ListByManagedInstanceOperationResponse

type ListByManagedInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerConfigurationOption
}

type ManagedInstanceId

type ManagedInstanceId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
}

ManagedInstanceId is a struct representing the Resource ID for a Managed Instance

func NewManagedInstanceID

func NewManagedInstanceID(subscriptionId string, resourceGroupName string, managedInstanceName string) ManagedInstanceId

NewManagedInstanceID returns a new ManagedInstanceId struct

func ParseManagedInstanceID

func ParseManagedInstanceID(input string) (*ManagedInstanceId, error)

ParseManagedInstanceID parses 'input' into a ManagedInstanceId

func ParseManagedInstanceIDInsensitively

func ParseManagedInstanceIDInsensitively(input string) (*ManagedInstanceId, error)

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

func (ManagedInstanceId) ID

func (id ManagedInstanceId) ID() string

ID returns the formatted Managed Instance ID

func (ManagedInstanceId) Segments

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

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

func (ManagedInstanceId) String

func (id ManagedInstanceId) String() string

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

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateCreated    ProvisioningState = "Created"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

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

type ServerConfigurationOption

type ServerConfigurationOption struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *ServerConfigurationOptionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type ServerConfigurationOptionOperationPredicate

type ServerConfigurationOptionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ServerConfigurationOptionOperationPredicate) Matches

func (p ServerConfigurationOptionOperationPredicate) Matches(input ServerConfigurationOption) bool

type ServerConfigurationOptionProperties

type ServerConfigurationOptionProperties struct {
	ProvisioningState              *ProvisioningState `json:"provisioningState,omitempty"`
	ServerConfigurationOptionValue int64              `json:"serverConfigurationOptionValue"`
}

type ServerConfigurationOptionsClient

type ServerConfigurationOptionsClient struct {
	Client *resourcemanager.Client
}

func NewServerConfigurationOptionsClientWithBaseURI

func NewServerConfigurationOptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerConfigurationOptionsClient, error)

func (ServerConfigurationOptionsClient) CreateOrUpdate

func (c ServerConfigurationOptionsClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceId, input ServerConfigurationOption) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerConfigurationOptionsClient) CreateOrUpdateThenPoll

func (c ServerConfigurationOptionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceId, input ServerConfigurationOption) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerConfigurationOptionsClient) Get

func (c ServerConfigurationOptionsClient) Get(ctx context.Context, id ManagedInstanceId) (result GetOperationResponse, err error)

Get ...

func (ServerConfigurationOptionsClient) ListByManagedInstance

func (c ServerConfigurationOptionsClient) ListByManagedInstance(ctx context.Context, id ManagedInstanceId) (result ListByManagedInstanceOperationResponse, err error)

ListByManagedInstance ...

func (ServerConfigurationOptionsClient) ListByManagedInstanceComplete

func (c ServerConfigurationOptionsClient) ListByManagedInstanceComplete(ctx context.Context, id ManagedInstanceId) (ListByManagedInstanceCompleteResult, error)

ListByManagedInstanceComplete retrieves all the results into a single object

func (ServerConfigurationOptionsClient) ListByManagedInstanceCompleteMatchingPredicate

func (c ServerConfigurationOptionsClient) ListByManagedInstanceCompleteMatchingPredicate(ctx context.Context, id ManagedInstanceId, predicate ServerConfigurationOptionOperationPredicate) (result ListByManagedInstanceCompleteResult, err error)

ListByManagedInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate