sqlagent

README

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

The sqlagent 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/sqlagent"

Client Initialization

client := sqlagent.NewSqlAgentClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlAgentClient.CreateOrUpdate

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

payload := sqlagent.SqlAgentConfiguration{
	// ...
}


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

Example Usage: SqlAgentClient.Get

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

Documentation

Index

• func PossibleValuesForState() []string
• func ValidateManagedInstanceID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• 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 SqlAgentClient
  • func NewSqlAgentClientWithBaseURI(api environments.Api) (*SqlAgentClient, error)
  • func (c SqlAgentClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceId, input SqlAgentConfiguration) (result CreateOrUpdateOperationResponse, err error)
  • func (c SqlAgentClient) Get(ctx context.Context, id ManagedInstanceId) (result GetOperationResponse, err error)
• type SqlAgentConfiguration
• type SqlAgentConfigurationProperties
• type State
  • func (s *State) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForState

func PossibleValuesForState() []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 {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SqlAgentConfiguration
}

type GetOperationResponse

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

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 SqlAgentClient

type SqlAgentClient struct {
	Client *resourcemanager.Client
}

func NewSqlAgentClientWithBaseURI

func NewSqlAgentClientWithBaseURI(api environments.Api) (*SqlAgentClient, error)

func (SqlAgentClient) CreateOrUpdate

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

CreateOrUpdate ...

func (SqlAgentClient) Get

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

Get ...

type SqlAgentConfiguration

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

type SqlAgentConfigurationProperties

type SqlAgentConfigurationProperties struct {
	State *State `json:"state,omitempty"`
}

type State

type State string

const (
	StateDisabled State = "Disabled"
	StateEnabled  State = "Enabled"
)

func (*State) UnmarshalJSON

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