advisor

package
v12.5.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package advisor implements the Azure ARM Advisor service API version 2017-04-19.

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 ARMErrorResponseBody 

type ARMErrorResponseBody struct {
	autorest.Response `json:"-"`
	// Message - Gets or sets the string that describes the error in detail and provides debugging information.
	Message *string `json:"message,omitempty"`
	// Code - Gets or sets the string that can be used to programmatically identify the error.
	Code *string `json:"code,omitempty"`
}

ARMErrorResponseBody ARM error response body.

type BaseClient 

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

BaseClient is the base client for Advisor.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Category 

type Category string

Category enumerates the values for category. 

const (
	// Cost ...
	Cost Category = "Cost"
	// HighAvailability ...
	HighAvailability Category = "HighAvailability"
	// Performance ...
	Performance Category = "Performance"
	// Security ...
	Security Category = "Security"
)

type ConfigData 

type ConfigData struct {
	// ID - The resource Id of the configuration resource.
	ID *string `json:"id,omitempty"`
	// Type - The type of the configuration resource.
	Type *string `json:"type,omitempty"`
	// Name - The name of the configuration resource.
	Name *string `json:"name,omitempty"`
	// Properties - The list of property name/value pairs.
	Properties *ConfigDataProperties `json:"properties,omitempty"`
}

ConfigData the Advisor configuration data structure.

type ConfigDataProperties 

type ConfigDataProperties struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties *map[string]*map[string]interface{} `json:",omitempty"`
	// Exclude - Exclude the resource from Advisor evaluations. Valid values: False (default) or True.
	Exclude *bool `json:"exclude,omitempty"`
	// LowCPUThreshold - Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.
	LowCPUThreshold *string `json:"low_cpu_threshold,omitempty"`
}

ConfigDataProperties the list of property name/value pairs.

type ConfigurationListResult 

type ConfigurationListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of configurations.
	Value *[]ConfigData `json:"value,omitempty"`
	// NextLink - The link used to get the next page of configurations.
	NextLink *string `json:"nextLink,omitempty"`
}

ConfigurationListResult the list of Advisor configurations.

type ConfigurationsClient 

type ConfigurationsClient struct {
	BaseClient
}

ConfigurationsClient is the REST APIs for Azure Advisor

func NewConfigurationsClient 

func NewConfigurationsClient(subscriptionID string) ConfigurationsClient

NewConfigurationsClient creates an instance of the ConfigurationsClient client.

func NewConfigurationsClientWithBaseURI 

func NewConfigurationsClientWithBaseURI(baseURI string, subscriptionID string) ConfigurationsClient

NewConfigurationsClientWithBaseURI creates an instance of the ConfigurationsClient client.

func (ConfigurationsClient) CreateInResourceGroup 

func (client ConfigurationsClient) CreateInResourceGroup(ctx context.Context, configContract ConfigData, resourceGroup string) (result ARMErrorResponseBody, err error)

CreateInResourceGroup sends the create in resource group request.

configContract is the Azure Advisor configuration data structure. resourceGroup is the name of the Azure resource group.

func (ConfigurationsClient) CreateInResourceGroupPreparer 

func (client ConfigurationsClient) CreateInResourceGroupPreparer(ctx context.Context, configContract ConfigData, resourceGroup string) (*http.Request, error)

CreateInResourceGroupPreparer prepares the CreateInResourceGroup request.

func (ConfigurationsClient) CreateInResourceGroupResponder 

func (client ConfigurationsClient) CreateInResourceGroupResponder(resp *http.Response) (result ARMErrorResponseBody, err error)

CreateInResourceGroupResponder handles the response to the CreateInResourceGroup request. The method always closes the http.Response Body.

func (ConfigurationsClient) CreateInResourceGroupSender 

func (client ConfigurationsClient) CreateInResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (ConfigurationsClient) CreateInSubscription 

func (client ConfigurationsClient) CreateInSubscription(ctx context.Context, configContract ConfigData) (result ARMErrorResponseBody, err error)

CreateInSubscription create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.

configContract is the Azure Advisor configuration data structure.

func (ConfigurationsClient) CreateInSubscriptionPreparer 

func (client ConfigurationsClient) CreateInSubscriptionPreparer(ctx context.Context, configContract ConfigData) (*http.Request, error)

CreateInSubscriptionPreparer prepares the CreateInSubscription request.

func (ConfigurationsClient) CreateInSubscriptionResponder 

func (client ConfigurationsClient) CreateInSubscriptionResponder(resp *http.Response) (result ARMErrorResponseBody, err error)

CreateInSubscriptionResponder handles the response to the CreateInSubscription request. The method always closes the http.Response Body.

func (ConfigurationsClient) CreateInSubscriptionSender 

func (client ConfigurationsClient) CreateInSubscriptionSender(req *http.Request) (*http.Response, error)

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

func (ConfigurationsClient) ListByResourceGroup 

func (client ConfigurationsClient) ListByResourceGroup(ctx context.Context, resourceGroup string) (result ConfigurationListResult, err error)

ListByResourceGroup sends the list by resource group request.

resourceGroup is the name of the Azure resource group.

func (ConfigurationsClient) ListByResourceGroupPreparer 

func (client ConfigurationsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroup string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ConfigurationsClient) ListByResourceGroupResponder 

func (client ConfigurationsClient) ListByResourceGroupResponder(resp *http.Response) (result ConfigurationListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ConfigurationsClient) ListByResourceGroupSender 

func (client ConfigurationsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (ConfigurationsClient) ListBySubscription 

func (client ConfigurationsClient) ListBySubscription(ctx context.Context) (result ConfigurationListResult, err error)

ListBySubscription retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.

func (ConfigurationsClient) ListBySubscriptionPreparer 

func (client ConfigurationsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ConfigurationsClient) ListBySubscriptionResponder 

func (client ConfigurationsClient) ListBySubscriptionResponder(resp *http.Response) (result ConfigurationListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ConfigurationsClient) ListBySubscriptionSender 

func (client ConfigurationsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

type Impact 

type Impact string

Impact enumerates the values for impact. 

const (
	// High ...
	High Impact = "High"
	// Low ...
	Low Impact = "Low"
	// Medium ...
	Medium Impact = "Medium"
)

type OperationDisplayInfo 

type OperationDisplayInfo struct {
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
	// Operation - The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`
	// Provider - Service provider: Microsoft Advisor.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo the operation supported by Advisor.

type OperationEntity 

type OperationEntity struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The operation supported by Advisor.
	Display *OperationDisplayInfo `json:"display,omitempty"`
}

OperationEntity the operation supported by Advisor.

type OperationEntityListResult 

type OperationEntityListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of operations.
	Value *[]OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult the list of Advisor operations.

func (OperationEntityListResult) IsEmpty 

func (oelr OperationEntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationEntityListResultIterator 

type OperationEntityListResultIterator struct {
	// contains filtered or unexported fields
}

OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.

func (*OperationEntityListResultIterator) Next 

func (iter *OperationEntityListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationEntityListResultIterator) NotDone 

func (iter OperationEntityListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationEntityListResultIterator) Response 

func (iter OperationEntityListResultIterator) Response() OperationEntityListResult

Response returns the raw server response from the last page request.

func (OperationEntityListResultIterator) Value 

func (iter OperationEntityListResultIterator) Value() OperationEntity

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationEntityListResultPage 

type OperationEntityListResultPage struct {
	// contains filtered or unexported fields
}

OperationEntityListResultPage contains a page of OperationEntity values.

func (*OperationEntityListResultPage) Next 

func (page *OperationEntityListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationEntityListResultPage) NotDone 

func (page OperationEntityListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationEntityListResultPage) Response 

func (page OperationEntityListResultPage) Response() OperationEntityListResult

Response returns the raw server response from the last page request.

func (OperationEntityListResultPage) Values 

func (page OperationEntityListResultPage) Values() []OperationEntity

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

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(ctx context.Context) (result OperationEntityListResultPage, err error)

List lists all the available Advisor REST API operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*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 - The category of the recommendation. Possible values include: 'HighAvailability', 'Security', 'Performance', 'Cost'
	Category Category `json:"category,omitempty"`
	// Impact - The business impact of the recommendation. Possible values include: 'High', 'Medium', 'Low'
	Impact Impact `json:"impact,omitempty"`
	// ImpactedField - The resource type identified by Advisor.
	ImpactedField *string `json:"impactedField,omitempty"`
	// ImpactedValue - The resource identified by Advisor.
	ImpactedValue *string `json:"impactedValue,omitempty"`
	// LastUpdated - The most recent time that Advisor checked the validity of the recommendation.
	LastUpdated *date.Time `json:"lastUpdated,omitempty"`
	// Metadata - The recommendation metadata.
	Metadata *map[string]*map[string]interface{} `json:"metadata,omitempty"`
	// RecommendationTypeID - The recommendation-type GUID.
	RecommendationTypeID *string `json:"recommendationTypeId,omitempty"`
	// Risk - The potential risk of not implementing the recommendation. Possible values include: 'Error', 'Warning', 'None'
	Risk Risk `json:"risk,omitempty"`
	// ShortDescription - A summary of the recommendation.
	ShortDescription *ShortDescription `json:"shortDescription,omitempty"`
	// SuppressionIds - The list of snoozed and dismissed rules for the recommendation.
	SuppressionIds *[]uuid.UUID `json:"suppressionIds,omitempty"`
}

RecommendationProperties the properties of the recommendation.

type RecommendationsClient 

type RecommendationsClient struct {
	BaseClient
}

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(ctx context.Context) (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(ctx context.Context) (*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(ctx context.Context, 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(ctx context.Context, operationID uuid.UUID) (result RecommendationsGetGenerateStatusFuture, 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(ctx context.Context, 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) (future RecommendationsGetGenerateStatusFuture, err 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(ctx context.Context, 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(ctx context.Context, filter string, top *int32, skipToken string) (result ResourceRecommendationBaseListResultPage, 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(ctx context.Context, filter string, top *int32, skipToken string) (result ResourceRecommendationBaseListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (RecommendationsClient) ListPreparer 

func (client RecommendationsClient) ListPreparer(ctx context.Context, 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 RecommendationsGetGenerateStatusFuture 

type RecommendationsGetGenerateStatusFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

RecommendationsGetGenerateStatusFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (RecommendationsGetGenerateStatusFuture) Result 

func (future RecommendationsGetGenerateStatusFuture) Result(client RecommendationsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Resource 

type Resource struct {
	// ID - The resource ID.
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource.
	Type *string `json:"type,omitempty"`
}

Resource an Azure resource.

type ResourceRecommendationBase 

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

ResourceRecommendationBase advisor Recommendation.

func (*ResourceRecommendationBase) UnmarshalJSON 

func (rrb *ResourceRecommendationBase) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceRecommendationBase struct.

type ResourceRecommendationBaseListResult 

type ResourceRecommendationBaseListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of recommendations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of recommendations.
	Value *[]ResourceRecommendationBase `json:"value,omitempty"`
}

ResourceRecommendationBaseListResult the list of Advisor recommendations.

func (ResourceRecommendationBaseListResult) IsEmpty 

func (rrblr ResourceRecommendationBaseListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceRecommendationBaseListResultIterator 

type ResourceRecommendationBaseListResultIterator struct {
	// contains filtered or unexported fields
}

ResourceRecommendationBaseListResultIterator provides access to a complete listing of ResourceRecommendationBase values.

func (*ResourceRecommendationBaseListResultIterator) Next 

func (iter *ResourceRecommendationBaseListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceRecommendationBaseListResultIterator) NotDone 

func (iter ResourceRecommendationBaseListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceRecommendationBaseListResultIterator) Response 

func (iter ResourceRecommendationBaseListResultIterator) Response() ResourceRecommendationBaseListResult

Response returns the raw server response from the last page request.

func (ResourceRecommendationBaseListResultIterator) Value 

func (iter ResourceRecommendationBaseListResultIterator) Value() ResourceRecommendationBase

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceRecommendationBaseListResultPage 

type ResourceRecommendationBaseListResultPage struct {
	// contains filtered or unexported fields
}

ResourceRecommendationBaseListResultPage contains a page of ResourceRecommendationBase values.

func (*ResourceRecommendationBaseListResultPage) Next 

func (page *ResourceRecommendationBaseListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ResourceRecommendationBaseListResultPage) NotDone 

func (page ResourceRecommendationBaseListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceRecommendationBaseListResultPage) Response 

func (page ResourceRecommendationBaseListResultPage) Response() ResourceRecommendationBaseListResult

Response returns the raw server response from the last page request.

func (ResourceRecommendationBaseListResultPage) Values 

func (page ResourceRecommendationBaseListResultPage) Values() []ResourceRecommendationBase

Values returns the slice of values for the current page or nil if there are no values.

type Risk 

type Risk string

Risk enumerates the values for risk. 

const (
	// Error ...
	Error Risk = "Error"
	// None ...
	None Risk = "None"
	// Warning ...
	Warning Risk = "Warning"
)

type ShortDescription 

type ShortDescription struct {
	// Problem - The issue or opportunity identified by the recommendation.
	Problem *string `json:"problem,omitempty"`
	// Solution - The remediation action suggested by the recommendation.
	Solution *string `json:"solution,omitempty"`
}

ShortDescription a summary of the recommendation.

type SuppressionContract 

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

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

func (*SuppressionContract) UnmarshalJSON 

func (sc *SuppressionContract) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SuppressionContract struct.

type SuppressionContractListResult 

type SuppressionContractListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of suppressions.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of suppressions.
	Value *[]SuppressionContract `json:"value,omitempty"`
}

SuppressionContractListResult the list of Advisor suppressions.

func (SuppressionContractListResult) IsEmpty 

func (sclr SuppressionContractListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SuppressionContractListResultIterator 

type SuppressionContractListResultIterator struct {
	// contains filtered or unexported fields
}

SuppressionContractListResultIterator provides access to a complete listing of SuppressionContract values.

func (*SuppressionContractListResultIterator) Next 

func (iter *SuppressionContractListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (SuppressionContractListResultIterator) NotDone 

func (iter SuppressionContractListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (SuppressionContractListResultIterator) Response 

func (iter SuppressionContractListResultIterator) Response() SuppressionContractListResult

Response returns the raw server response from the last page request.

func (SuppressionContractListResultIterator) Value 

func (iter SuppressionContractListResultIterator) Value() SuppressionContract

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type SuppressionContractListResultPage 

type SuppressionContractListResultPage struct {
	// contains filtered or unexported fields
}

SuppressionContractListResultPage contains a page of SuppressionContract values.

func (*SuppressionContractListResultPage) Next 

func (page *SuppressionContractListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (SuppressionContractListResultPage) NotDone 

func (page SuppressionContractListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (SuppressionContractListResultPage) Response 

func (page SuppressionContractListResultPage) Response() SuppressionContractListResult

Response returns the raw server response from the last page request.

func (SuppressionContractListResultPage) Values 

func (page SuppressionContractListResultPage) Values() []SuppressionContract

Values returns the slice of values for the current page or nil if there are no values.

type SuppressionProperties 

type SuppressionProperties struct {
	// SuppressionID - The GUID of the suppression.
	SuppressionID *string `json:"suppressionId,omitempty"`
	// TTL - The duration for which the suppression is valid.
	TTL *string `json:"ttl,omitempty"`
}

SuppressionProperties the properties of the suppression.

type SuppressionsClient 

type SuppressionsClient struct {
	BaseClient
}

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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, top *int32, skipToken string) (result SuppressionContractListResultPage, 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.

top is the number of suppressions 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 (SuppressionsClient) ListComplete 

func (client SuppressionsClient) ListComplete(ctx context.Context, top *int32, skipToken string) (result SuppressionContractListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (SuppressionsClient) ListPreparer 

func (client SuppressionsClient) ListPreparer(ctx context.Context, top *int32, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (SuppressionsClient) ListResponder 

func (client SuppressionsClient) ListResponder(resp *http.Response) (result SuppressionContractListResult, 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.