advisors

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2018-06-01/advisors Documentation

The advisors SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2018-06-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/postgresql/2018-06-01/advisors"

Client Initialization

client := advisors.NewAdvisorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AdvisorsClient.Get

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

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

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

Documentation

Index

• func ValidateAdvisorID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateServerID(input interface{}, key string) (warnings []string, errors []error)
• type Advisor
• type AdvisorId
  • func NewAdvisorID(subscriptionId string, resourceGroupName string, serverName string, ...) AdvisorId
  • func ParseAdvisorID(input string) (*AdvisorId, error)
  • func ParseAdvisorIDInsensitively(input string) (*AdvisorId, error)
  • func (id AdvisorId) ID() string
  • func (id AdvisorId) Segments() []resourceids.Segment
  • func (id AdvisorId) String() string
• type AdvisorOperationPredicate
  • func (p AdvisorOperationPredicate) Matches(input Advisor) bool
• type AdvisorsClient
  • func NewAdvisorsClientWithBaseURI(sdkApi sdkEnv.Api) (*AdvisorsClient, error)
  • func (c AdvisorsClient) Get(ctx context.Context, id AdvisorId) (result GetOperationResponse, err error)
  • func (c AdvisorsClient) ListByServer(ctx context.Context, id ServerId) (result ListByServerOperationResponse, err error)
  • func (c AdvisorsClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)
  • func (c AdvisorsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate AdvisorOperationPredicate) (result ListByServerCompleteResult, err error)
• type GetOperationResponse
• type ListByServerCompleteResult
• type ListByServerOperationResponse
• type ServerId
  • func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId
  • func ParseServerID(input string) (*ServerId, error)
  • func ParseServerIDInsensitively(input string) (*ServerId, error)
  • func (id ServerId) ID() string
  • func (id ServerId) Segments() []resourceids.Segment
  • func (id ServerId) String() string

Functions

func ValidateAdvisorID

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

ValidateAdvisorID checks that 'input' can be parsed as a Advisor ID

func ValidateServerID

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

ValidateServerID checks that 'input' can be parsed as a Server ID

Types

type Advisor

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

type AdvisorId

type AdvisorId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	AdvisorName       string
}

AdvisorId is a struct representing the Resource ID for a Advisor

func NewAdvisorID

func NewAdvisorID(subscriptionId string, resourceGroupName string, serverName string, advisorName string) AdvisorId

NewAdvisorID returns a new AdvisorId struct

func ParseAdvisorID

func ParseAdvisorID(input string) (*AdvisorId, error)

ParseAdvisorID parses 'input' into a AdvisorId

func ParseAdvisorIDInsensitively

func ParseAdvisorIDInsensitively(input string) (*AdvisorId, error)

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

func (AdvisorId) ID

func (id AdvisorId) ID() string

ID returns the formatted Advisor ID

func (AdvisorId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Advisor ID

func (AdvisorId) String

func (id AdvisorId) String() string

String returns a human-readable description of this Advisor ID

type AdvisorOperationPredicate

type AdvisorOperationPredicate struct {
	Id         *string
	Name       *string
	Properties *interface{}
	Type       *string
}

func (AdvisorOperationPredicate) Matches

func (p AdvisorOperationPredicate) Matches(input Advisor) bool

type AdvisorsClient

type AdvisorsClient struct {
	Client *resourcemanager.Client
}

func NewAdvisorsClientWithBaseURI

func NewAdvisorsClientWithBaseURI(sdkApi sdkEnv.Api) (*AdvisorsClient, error)

func (AdvisorsClient) Get

func (c AdvisorsClient) Get(ctx context.Context, id AdvisorId) (result GetOperationResponse, err error)

Get ...

func (AdvisorsClient) ListByServer

func (c AdvisorsClient) ListByServer(ctx context.Context, id ServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (AdvisorsClient) ListByServerComplete

func (c AdvisorsClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (AdvisorsClient) ListByServerCompleteMatchingPredicate

func (c AdvisorsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate AdvisorOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []Advisor
}

type ListByServerOperationResponse

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

type ServerId

type ServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID

func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId

NewServerID returns a new ServerId struct

func ParseServerID

func ParseServerID(input string) (*ServerId, error)

ParseServerID parses 'input' into a ServerId

func ParseServerIDInsensitively

func ParseServerIDInsensitively(input string) (*ServerId, error)

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

func (ServerId) ID

func (id ServerId) ID() string

ID returns the formatted Server ID

func (ServerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Server ID

func (ServerId) String

func (id ServerId) String() string

String returns a human-readable description of this Server ID