advisor

package
v11.2.1-beta+incompatible Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package advisor implements the Azure ARM Advisor service API version 2017-03-31.

REST APIs for Azure Advisor

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Advisor
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Category

type Category string

Category enumerates the values for category.

const (
	// Cost specifies the cost state for category.
	Cost Category = "Cost"
	// HighAvailability specifies the high availability state for category.
	HighAvailability Category = "HighAvailability"
	// Performance specifies the performance state for category.
	Performance Category = "Performance"
	// Security specifies the security state for category.
	Security Category = "Security"
)

type Impact

type Impact string

Impact enumerates the values for impact.

const (
	// High specifies the high state for impact.
	High Impact = "High"
	// Low specifies the low state for impact.
	Low Impact = "Low"
	// Medium specifies the medium state for impact.
	Medium Impact = "Medium"
)

type ListSuppressionContract

type ListSuppressionContract struct {
	autorest.Response `json:"-"`
	Value             *[]SuppressionContract `json:"value,omitempty"`
}

ListSuppressionContract is

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Advisor.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type OperationDisplayInfo

type OperationDisplayInfo struct {
	Description *string `json:"description,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
}

OperationDisplayInfo is the operation supported by Advisor.

type OperationEntity

type OperationEntity struct {
	Name    *string               `json:"name,omitempty"`
	Display *OperationDisplayInfo `json:"display,omitempty"`
}

OperationEntity is the operation supported by Advisor.

type OperationEntityListResult

type OperationEntityListResult struct {
	autorest.Response `json:"-"`
	NextLink          *string            `json:"nextLink,omitempty"`
	Value             *[]OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult is the list of Advisor operations.

func (OperationEntityListResult) OperationEntityListResultPreparer

func (client OperationEntityListResult) OperationEntityListResultPreparer() (*http.Request, error)

OperationEntityListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type OperationsClient

type OperationsClient struct {
	ManagementClient
}

OperationsClient is the REST APIs for Azure Advisor

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List

func (client OperationsClient) List() (result OperationEntityListResult, err error)

List lists all the available Advisor REST API operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(cancel <-chan struct{}) (<-chan OperationEntity, <-chan error)

ListComplete gets all elements from the list without paging.

func (OperationsClient) ListNextResults

func (client OperationsClient) ListNextResults(lastResults OperationEntityListResult) (result OperationEntityListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type RecommendationProperties

type RecommendationProperties struct {
	Category             Category                            `json:"category,omitempty"`
	Impact               Impact                              `json:"impact,omitempty"`
	ImpactedField        *string                             `json:"impactedField,omitempty"`
	ImpactedValue        *string                             `json:"impactedValue,omitempty"`
	LastUpdated          *date.Time                          `json:"lastUpdated,omitempty"`
	Metadata             *map[string]*map[string]interface{} `json:"metadata,omitempty"`
	RecommendationTypeID *string                             `json:"recommendationTypeId,omitempty"`
	Risk                 Risk                                `json:"risk,omitempty"`
	ShortDescription     *ShortDescription                   `json:"shortDescription,omitempty"`
	SuppressionIds       *[]uuid.UUID                        `json:"suppressionIds,omitempty"`
}

RecommendationProperties is the properties of the recommendation.

type RecommendationsClient

type RecommendationsClient struct {
	ManagementClient
}

RecommendationsClient is the REST APIs for Azure Advisor

func NewRecommendationsClient

func NewRecommendationsClient(subscriptionID string) RecommendationsClient

NewRecommendationsClient creates an instance of the RecommendationsClient client.

func NewRecommendationsClientWithBaseURI

func NewRecommendationsClientWithBaseURI(baseURI string, subscriptionID string) RecommendationsClient

NewRecommendationsClientWithBaseURI creates an instance of the RecommendationsClient client.

func (RecommendationsClient) Generate

func (client RecommendationsClient) Generate() (result autorest.Response, err error)

Generate initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

func (RecommendationsClient) GeneratePreparer

func (client RecommendationsClient) GeneratePreparer() (*http.Request, error)

GeneratePreparer prepares the Generate request.

func (RecommendationsClient) GenerateResponder

func (client RecommendationsClient) GenerateResponder(resp *http.Response) (result autorest.Response, err error)

GenerateResponder handles the response to the Generate request. The method always closes the http.Response Body.

func (RecommendationsClient) GenerateSender

func (client RecommendationsClient) GenerateSender(req *http.Request) (*http.Response, error)

GenerateSender sends the Generate request. The method will close the http.Response Body if it receives an error.

func (RecommendationsClient) Get

func (client RecommendationsClient) Get(resourceURI string, recommendationID string) (result ResourceRecommendationBase, err error)

Get obtains details of a cached recommendation.

resourceURI is the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID is the recommendation ID.

func (RecommendationsClient) GetGenerateStatus

func (client RecommendationsClient) GetGenerateStatus(operationID uuid.UUID) (result autorest.Response, err error)

GetGenerateStatus retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

operationID is the operation ID, which can be found from the Location field in the generate recommendation response header.

func (RecommendationsClient) GetGenerateStatusPreparer

func (client RecommendationsClient) GetGenerateStatusPreparer(operationID uuid.UUID) (*http.Request, error)

GetGenerateStatusPreparer prepares the GetGenerateStatus request.

func (RecommendationsClient) GetGenerateStatusResponder

func (client RecommendationsClient) GetGenerateStatusResponder(resp *http.Response) (result autorest.Response, err error)

GetGenerateStatusResponder handles the response to the GetGenerateStatus request. The method always closes the http.Response Body.

func (RecommendationsClient) GetGenerateStatusSender

func (client RecommendationsClient) GetGenerateStatusSender(req *http.Request) (*http.Response, error)

GetGenerateStatusSender sends the GetGenerateStatus request. The method will close the http.Response Body if it receives an error.

func (RecommendationsClient) GetPreparer

func (client RecommendationsClient) GetPreparer(resourceURI string, recommendationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RecommendationsClient) GetResponder

func (client RecommendationsClient) GetResponder(resp *http.Response) (result ResourceRecommendationBase, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (RecommendationsClient) GetSender

func (client RecommendationsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (RecommendationsClient) List

func (client RecommendationsClient) List(filter string, top *int32, skipToken string) (result ResourceRecommendationBaseListResult, err error)

List obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

filter is the filter to apply to the recommendations. top is the number of recommendations per page if a paged version of this API is being used. skipToken is the page-continuation token to use with a paged version of this API.

func (RecommendationsClient) ListComplete

func (client RecommendationsClient) ListComplete(filter string, top *int32, skipToken string, cancel <-chan struct{}) (<-chan ResourceRecommendationBase, <-chan error)

ListComplete gets all elements from the list without paging.

func (RecommendationsClient) ListNextResults

ListNextResults retrieves the next set of results, if any.

func (RecommendationsClient) ListPreparer

func (client RecommendationsClient) ListPreparer(filter string, top *int32, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (RecommendationsClient) ListResponder

func (client RecommendationsClient) ListResponder(resp *http.Response) (result ResourceRecommendationBaseListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RecommendationsClient) ListSender

func (client RecommendationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Resource

type Resource struct {
	ID   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

Resource is an Azure resource.

type ResourceRecommendationBase

type ResourceRecommendationBase struct {
	autorest.Response         `json:"-"`
	ID                        *string `json:"id,omitempty"`
	Name                      *string `json:"name,omitempty"`
	Type                      *string `json:"type,omitempty"`
	*RecommendationProperties `json:"properties,omitempty"`
}

ResourceRecommendationBase is advisor Recommendation.

type ResourceRecommendationBaseListResult

type ResourceRecommendationBaseListResult struct {
	autorest.Response `json:"-"`
	NextLink          *string                       `json:"nextLink,omitempty"`
	Value             *[]ResourceRecommendationBase `json:"value,omitempty"`
}

ResourceRecommendationBaseListResult is the list of Advisor recommendations.

func (ResourceRecommendationBaseListResult) ResourceRecommendationBaseListResultPreparer

func (client ResourceRecommendationBaseListResult) ResourceRecommendationBaseListResultPreparer() (*http.Request, error)

ResourceRecommendationBaseListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type Risk

type Risk string

Risk enumerates the values for risk.

const (
	// Error specifies the error state for risk.
	Error Risk = "Error"
	// None specifies the none state for risk.
	None Risk = "None"
	// Warning specifies the warning state for risk.
	Warning Risk = "Warning"
)

type ShortDescription

type ShortDescription struct {
	Problem  *string `json:"problem,omitempty"`
	Solution *string `json:"solution,omitempty"`
}

ShortDescription is a summary of the recommendation.

type SuppressionContract

type SuppressionContract struct {
	autorest.Response      `json:"-"`
	ID                     *string `json:"id,omitempty"`
	Name                   *string `json:"name,omitempty"`
	Type                   *string `json:"type,omitempty"`
	*SuppressionProperties `json:"properties,omitempty"`
}

SuppressionContract is the details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.

type SuppressionProperties

type SuppressionProperties struct {
	SuppressionID *string `json:"suppressionId,omitempty"`
	TTL           *string `json:"ttl,omitempty"`
}

SuppressionProperties is the properties of the suppression.

type SuppressionsClient

type SuppressionsClient struct {
	ManagementClient
}

SuppressionsClient is the REST APIs for Azure Advisor

func NewSuppressionsClient

func NewSuppressionsClient(subscriptionID string) SuppressionsClient

NewSuppressionsClient creates an instance of the SuppressionsClient client.

func NewSuppressionsClientWithBaseURI

func NewSuppressionsClientWithBaseURI(baseURI string, subscriptionID string) SuppressionsClient

NewSuppressionsClientWithBaseURI creates an instance of the SuppressionsClient client.

func (SuppressionsClient) Create

func (client SuppressionsClient) Create(resourceURI string, recommendationID string, name string, suppressionContract SuppressionContract) (result SuppressionContract, err error)

Create enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.

resourceURI is the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID is the recommendation ID. name is the name of the suppression. suppressionContract is the snoozed or dismissed attribute; for example, the snooze duration.

func (SuppressionsClient) CreatePreparer

func (client SuppressionsClient) CreatePreparer(resourceURI string, recommendationID string, name string, suppressionContract SuppressionContract) (*http.Request, error)

CreatePreparer prepares the Create request.

func (SuppressionsClient) CreateResponder

func (client SuppressionsClient) CreateResponder(resp *http.Response) (result SuppressionContract, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (SuppressionsClient) CreateSender

func (client SuppressionsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (SuppressionsClient) Delete

func (client SuppressionsClient) Delete(resourceURI string, recommendationID string, name string) (result autorest.Response, err error)

Delete enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

resourceURI is the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID is the recommendation ID. name is the name of the suppression.

func (SuppressionsClient) DeletePreparer

func (client SuppressionsClient) DeletePreparer(resourceURI string, recommendationID string, name string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SuppressionsClient) DeleteResponder

func (client SuppressionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SuppressionsClient) DeleteSender

func (client SuppressionsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (SuppressionsClient) Get

func (client SuppressionsClient) Get(resourceURI string, recommendationID string, name string) (result SuppressionContract, err error)

Get obtains the details of a suppression.

resourceURI is the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID is the recommendation ID. name is the name of the suppression.

func (SuppressionsClient) GetPreparer

func (client SuppressionsClient) GetPreparer(resourceURI string, recommendationID string, name string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SuppressionsClient) GetResponder

func (client SuppressionsClient) GetResponder(resp *http.Response) (result SuppressionContract, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SuppressionsClient) GetSender

func (client SuppressionsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SuppressionsClient) List

func (client SuppressionsClient) List() (result ListSuppressionContract, err error)

List retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

func (SuppressionsClient) ListPreparer

func (client SuppressionsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (SuppressionsClient) ListResponder

func (client SuppressionsClient) ListResponder(resp *http.Response) (result ListSuppressionContract, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (SuppressionsClient) ListSender

func (client SuppressionsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

Jump to

Keyboard shortcuts

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