import "github.com/Azure/azure-sdk-for-go/services/advisor/mgmt/2020-01-01/advisor"
Package advisor implements the Azure ARM Advisor service API version 2020-01-01.
REST APIs for Azure Advisor
client.go configurations.go enums.go models.go operations.go recommendationmetadata.go recommendations.go suppressions.go version.go
const (
// DefaultBaseURI is the default URI used for the service Advisor
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type ARMErrorResponseBody struct {
// 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 ArmErrorResponse struct {
Error *ARMErrorResponseBody `json:"error,omitempty"`
}ArmErrorResponse ...
BaseClient is the base client for Advisor.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CPUThreshold enumerates the values for cpu threshold.
const (
// Five ...
Five CPUThreshold = "5"
// OneFive ...
OneFive CPUThreshold = "15"
// OneZero ...
OneZero CPUThreshold = "10"
// TwoZero ...
TwoZero CPUThreshold = "20"
)func PossibleCPUThresholdValues() []CPUThreshold
PossibleCPUThresholdValues returns an array of possible values for the CPUThreshold const type.
Category enumerates the values for category.
const (
// Cost ...
Cost Category = "Cost"
// HighAvailability ...
HighAvailability Category = "HighAvailability"
// OperationalExcellence ...
OperationalExcellence Category = "OperationalExcellence"
// Performance ...
Performance Category = "Performance"
// Security ...
Security Category = "Security"
)PossibleCategoryValues returns an array of possible values for the Category const type.
type ConfigData struct {
autorest.Response `json:"-"`
// ConfigDataProperties - The Advisor configuration data structure.
*ConfigDataProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
}ConfigData the Advisor configuration data structure.
func (cd ConfigData) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ConfigData.
func (cd *ConfigData) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ConfigData struct.
type ConfigDataProperties struct {
// 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. Possible values include: 'Five', 'OneZero', 'OneFive', 'TwoZero'
LowCPUThreshold CPUThreshold `json:"lowCpuThreshold,omitempty"`
// Digests - Advisor digest configuration. Valid only for subscriptions
Digests *[]DigestConfig `json:"digests,omitempty"`
}ConfigDataProperties configuration data properties
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.
func (clr ConfigurationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ConfigurationListResultIterator struct {
// contains filtered or unexported fields
}ConfigurationListResultIterator provides access to a complete listing of ConfigData values.
func NewConfigurationListResultIterator(page ConfigurationListResultPage) ConfigurationListResultIterator
Creates a new instance of the ConfigurationListResultIterator type.
func (iter *ConfigurationListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (iter *ConfigurationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ConfigurationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ConfigurationListResultIterator) Response() ConfigurationListResult
Response returns the raw server response from the last page request.
func (iter ConfigurationListResultIterator) Value() ConfigData
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ConfigurationListResultPage struct {
// contains filtered or unexported fields
}ConfigurationListResultPage contains a page of ConfigData values.
func NewConfigurationListResultPage(cur ConfigurationListResult, getNextPage func(context.Context, ConfigurationListResult) (ConfigurationListResult, error)) ConfigurationListResultPage
Creates a new instance of the ConfigurationListResultPage type.
func (page *ConfigurationListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (page *ConfigurationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page ConfigurationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ConfigurationListResultPage) Response() ConfigurationListResult
Response returns the raw server response from the last page request.
func (page ConfigurationListResultPage) Values() []ConfigData
Values returns the slice of values for the current page or nil if there are no values.
type ConfigurationsClient struct {
BaseClient
}ConfigurationsClient is the REST APIs for Azure Advisor
func NewConfigurationsClient(subscriptionID string) ConfigurationsClient
NewConfigurationsClient creates an instance of the ConfigurationsClient client.
func NewConfigurationsClientWithBaseURI(baseURI string, subscriptionID string) ConfigurationsClient
NewConfigurationsClientWithBaseURI creates an instance of the ConfigurationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ConfigurationsClient) CreateInResourceGroup(ctx context.Context, configContract ConfigData, resourceGroup string) (result ConfigData, err error)
CreateInResourceGroup sends the create in resource group request. Parameters: configContract - the Azure Advisor configuration data structure. resourceGroup - the name of the Azure resource group.
func (client ConfigurationsClient) CreateInResourceGroupPreparer(ctx context.Context, configContract ConfigData, resourceGroup string) (*http.Request, error)
CreateInResourceGroupPreparer prepares the CreateInResourceGroup request.
func (client ConfigurationsClient) CreateInResourceGroupResponder(resp *http.Response) (result ConfigData, err error)
CreateInResourceGroupResponder handles the response to the CreateInResourceGroup request. The method always closes the http.Response Body.
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 (client ConfigurationsClient) CreateInSubscription(ctx context.Context, configContract ConfigData) (result ConfigData, err error)
CreateInSubscription create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups. Parameters: configContract - the Azure Advisor configuration data structure.
func (client ConfigurationsClient) CreateInSubscriptionPreparer(ctx context.Context, configContract ConfigData) (*http.Request, error)
CreateInSubscriptionPreparer prepares the CreateInSubscription request.
func (client ConfigurationsClient) CreateInSubscriptionResponder(resp *http.Response) (result ConfigData, err error)
CreateInSubscriptionResponder handles the response to the CreateInSubscription request. The method always closes the http.Response Body.
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 (client ConfigurationsClient) ListByResourceGroup(ctx context.Context, resourceGroup string) (result ConfigurationListResult, err error)
ListByResourceGroup sends the list by resource group request. Parameters: resourceGroup - the name of the Azure resource group.
func (client ConfigurationsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroup string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client ConfigurationsClient) ListBySubscription(ctx context.Context) (result ConfigurationListResultPage, err error)
ListBySubscription retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
func (client ConfigurationsClient) ListBySubscriptionComplete(ctx context.Context) (result ConfigurationListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ConfigurationsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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 (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 DigestConfig struct {
// Name - Name of digest configuration. Value is case-insensitive and must be unique within a subscription.
Name *string `json:"name,omitempty"`
// ActionGroupResourceID - Action group resource id used by digest.
ActionGroupResourceID *string `json:"actionGroupResourceId,omitempty"`
// Frequency - Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive.
Frequency *int32 `json:"frequency,omitempty"`
// Categories - Categories to send digest for. If categories are not provided, then digest will be sent for all categories.
Categories *[]Category `json:"categories,omitempty"`
// Language - Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en).
Language *string `json:"language,omitempty"`
// State - State of digest configuration. Possible values include: 'Active', 'Disabled'
State DigestConfigState `json:"state,omitempty"`
}DigestConfig advisor Digest configuration entity
DigestConfigState enumerates the values for digest config state.
const (
// Active ...
Active DigestConfigState = "Active"
// Disabled ...
Disabled DigestConfigState = "Disabled"
)func PossibleDigestConfigStateValues() []DigestConfigState
PossibleDigestConfigStateValues returns an array of possible values for the DigestConfigState const type.
Impact enumerates the values for impact.
const (
// High ...
High Impact = "High"
// Low ...
Low Impact = "Low"
// Medium ...
Medium Impact = "Medium"
)PossibleImpactValues returns an array of possible values for the Impact const type.
type MetadataEntity struct {
// ID - The resource Id of the metadata entity.
ID *string `json:"id,omitempty"`
// Type - The type of the metadata entity.
Type *string `json:"type,omitempty"`
// Name - The name of the metadata entity.
Name *string `json:"name,omitempty"`
// MetadataEntityProperties - The metadata entity properties.
*MetadataEntityProperties `json:"properties,omitempty"`
}MetadataEntity the metadata entity contract.
func (me MetadataEntity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetadataEntity.
func (me *MetadataEntity) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MetadataEntity struct.
type MetadataEntityListResult struct {
autorest.Response `json:"-"`
// Value - The list of metadata entities.
Value *[]MetadataEntity `json:"value,omitempty"`
// NextLink - The link used to get the next page of metadata.
NextLink *string `json:"nextLink,omitempty"`
}MetadataEntityListResult the list of metadata entities
func (melr MetadataEntityListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type MetadataEntityListResultIterator struct {
// contains filtered or unexported fields
}MetadataEntityListResultIterator provides access to a complete listing of MetadataEntity values.
func NewMetadataEntityListResultIterator(page MetadataEntityListResultPage) MetadataEntityListResultIterator
Creates a new instance of the MetadataEntityListResultIterator type.
func (iter *MetadataEntityListResultIterator) 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. Deprecated: Use NextWithContext() instead.
func (iter *MetadataEntityListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter MetadataEntityListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter MetadataEntityListResultIterator) Response() MetadataEntityListResult
Response returns the raw server response from the last page request.
func (iter MetadataEntityListResultIterator) Value() MetadataEntity
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type MetadataEntityListResultPage struct {
// contains filtered or unexported fields
}MetadataEntityListResultPage contains a page of MetadataEntity values.
func NewMetadataEntityListResultPage(cur MetadataEntityListResult, getNextPage func(context.Context, MetadataEntityListResult) (MetadataEntityListResult, error)) MetadataEntityListResultPage
Creates a new instance of the MetadataEntityListResultPage type.
func (page *MetadataEntityListResultPage) 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. Deprecated: Use NextWithContext() instead.
func (page *MetadataEntityListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page MetadataEntityListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page MetadataEntityListResultPage) Response() MetadataEntityListResult
Response returns the raw server response from the last page request.
func (page MetadataEntityListResultPage) Values() []MetadataEntity
Values returns the slice of values for the current page or nil if there are no values.
type MetadataEntityProperties struct {
// DisplayName - The display name.
DisplayName *string `json:"displayName,omitempty"`
// DependsOn - The list of keys on which this entity depends on.
DependsOn *[]string `json:"dependsOn,omitempty"`
// ApplicableScenarios - The list of scenarios applicable to this metadata entity.
ApplicableScenarios *[]Scenario `json:"applicableScenarios,omitempty"`
// SupportedValues - The list of supported values.
SupportedValues *[]MetadataSupportedValueDetail `json:"supportedValues,omitempty"`
}MetadataEntityProperties the metadata entity properties
type MetadataSupportedValueDetail struct {
// ID - The id.
ID *string `json:"id,omitempty"`
// DisplayName - The display name.
DisplayName *string `json:"displayName,omitempty"`
}MetadataSupportedValueDetail the metadata supported value detail.
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 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 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 (oelr OperationEntityListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationEntityListResultIterator struct {
// contains filtered or unexported fields
}OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.
func NewOperationEntityListResultIterator(page OperationEntityListResultPage) OperationEntityListResultIterator
Creates a new instance of the OperationEntityListResultIterator type.
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. Deprecated: Use NextWithContext() instead.
func (iter *OperationEntityListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationEntityListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationEntityListResultIterator) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}OperationEntityListResultPage contains a page of OperationEntity values.
func NewOperationEntityListResultPage(cur OperationEntityListResult, getNextPage func(context.Context, OperationEntityListResult) (OperationEntityListResult, error)) OperationEntityListResultPage
Creates a new instance of the OperationEntityListResultPage type.
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. Deprecated: Use NextWithContext() instead.
func (page *OperationEntityListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page OperationEntityListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationEntityListResultPage) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
func (page OperationEntityListResultPage) Values() []OperationEntity
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient struct {
BaseClient
}OperationsClient is the REST APIs for Azure Advisor
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationEntityListResultPage, err error)
List lists all the available Advisor REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type RecommendationMetadataClient struct {
BaseClient
}RecommendationMetadataClient is the REST APIs for Azure Advisor
func NewRecommendationMetadataClient(subscriptionID string) RecommendationMetadataClient
NewRecommendationMetadataClient creates an instance of the RecommendationMetadataClient client.
func NewRecommendationMetadataClientWithBaseURI(baseURI string, subscriptionID string) RecommendationMetadataClient
NewRecommendationMetadataClientWithBaseURI creates an instance of the RecommendationMetadataClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client RecommendationMetadataClient) Get(ctx context.Context, name string) (result SetObject, err error)
Get sends the get request. Parameters: name - name of metadata entity.
func (client RecommendationMetadataClient) GetPreparer(ctx context.Context, name string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RecommendationMetadataClient) GetResponder(resp *http.Response) (result SetObject, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client RecommendationMetadataClient) List(ctx context.Context) (result MetadataEntityListResultPage, err error)
List sends the list request.
func (client RecommendationMetadataClient) ListComplete(ctx context.Context) (result MetadataEntityListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client RecommendationMetadataClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client RecommendationMetadataClient) ListResponder(resp *http.Response) (result MetadataEntityListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type RecommendationProperties struct {
// Category - The category of the recommendation. Possible values include: 'HighAvailability', 'Security', 'Performance', 'Cost', 'OperationalExcellence'
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]interface{} `json:"metadata"`
// 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"`
// ExtendedProperties - Extended properties
ExtendedProperties map[string]*string `json:"extendedProperties"`
// ResourceMetadata - Metadata of resource that was assessed
ResourceMetadata *ResourceMetadata `json:"resourceMetadata,omitempty"`
}RecommendationProperties the properties of the recommendation.
func (rp RecommendationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecommendationProperties.
type RecommendationsClient struct {
BaseClient
}RecommendationsClient is the REST APIs for Azure Advisor
func NewRecommendationsClient(subscriptionID string) RecommendationsClient
NewRecommendationsClient creates an instance of the RecommendationsClient client.
func NewRecommendationsClientWithBaseURI(baseURI string, subscriptionID string) RecommendationsClient
NewRecommendationsClientWithBaseURI creates an instance of the RecommendationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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.
GeneratePreparer prepares the Generate request.
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.
GenerateSender sends the Generate request. The method will close the http.Response Body if it receives an error.
func (client RecommendationsClient) Get(ctx context.Context, resourceURI string, recommendationID string) (result ResourceRecommendationBase, err error)
Get obtains details of a cached recommendation. Parameters: resourceURI - the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID - the recommendation ID.
func (client RecommendationsClient) GetGenerateStatus(ctx context.Context, 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. Parameters: operationID - the operation ID, which can be found from the Location field in the generate recommendation response header.
func (client RecommendationsClient) GetGenerateStatusPreparer(ctx context.Context, operationID uuid.UUID) (*http.Request, error)
GetGenerateStatusPreparer prepares the GetGenerateStatus request.
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 (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 (client RecommendationsClient) GetPreparer(ctx context.Context, resourceURI string, recommendationID string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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. Parameters: filter - the filter to apply to the recommendations.<br>Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].<br>Example:<br>- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' top - the number of recommendations per page if a paged version of this API is being used. skipToken - the page-continuation token to use with a paged version of this API.
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 (client RecommendationsClient) ListPreparer(ctx context.Context, filter string, top *int32, skipToken string) (*http.Request, error)
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource struct {
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
}Resource an Azure resource.
type ResourceMetadata struct {
// ResourceID - Azure resource Id of the assessed resource
ResourceID *string `json:"resourceId,omitempty"`
// Source - Source from which recommendation is generated
Source *string `json:"source,omitempty"`
}ResourceMetadata recommendation resource metadata
type ResourceRecommendationBase struct {
autorest.Response `json:"-"`
// RecommendationProperties - The properties of the recommendation.
*RecommendationProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
}ResourceRecommendationBase advisor Recommendation.
func (rrb ResourceRecommendationBase) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceRecommendationBase.
func (rrb *ResourceRecommendationBase) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ResourceRecommendationBase struct.
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 (rrblr ResourceRecommendationBaseListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ResourceRecommendationBaseListResultIterator struct {
// contains filtered or unexported fields
}ResourceRecommendationBaseListResultIterator provides access to a complete listing of ResourceRecommendationBase values.
func NewResourceRecommendationBaseListResultIterator(page ResourceRecommendationBaseListResultPage) ResourceRecommendationBaseListResultIterator
Creates a new instance of the ResourceRecommendationBaseListResultIterator type.
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. Deprecated: Use NextWithContext() instead.
func (iter *ResourceRecommendationBaseListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ResourceRecommendationBaseListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceRecommendationBaseListResultIterator) Response() ResourceRecommendationBaseListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}ResourceRecommendationBaseListResultPage contains a page of ResourceRecommendationBase values.
func NewResourceRecommendationBaseListResultPage(cur ResourceRecommendationBaseListResult, getNextPage func(context.Context, ResourceRecommendationBaseListResult) (ResourceRecommendationBaseListResult, error)) ResourceRecommendationBaseListResultPage
Creates a new instance of the ResourceRecommendationBaseListResultPage type.
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. Deprecated: Use NextWithContext() instead.
func (page *ResourceRecommendationBaseListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page ResourceRecommendationBaseListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceRecommendationBaseListResultPage) Response() ResourceRecommendationBaseListResult
Response returns the raw server response from the last page request.
func (page ResourceRecommendationBaseListResultPage) Values() []ResourceRecommendationBase
Values returns the slice of values for the current page or nil if there are no values.
Risk enumerates the values for risk.
const (
// Error ...
Error Risk = "Error"
// None ...
None Risk = "None"
// Warning ...
Warning Risk = "Warning"
)PossibleRiskValues returns an array of possible values for the Risk const type.
Scenario enumerates the values for scenario.
PossibleScenarioValues returns an array of possible values for the Scenario const type.
SetObject ...
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 struct {
autorest.Response `json:"-"`
// SuppressionProperties - The properties of the suppression.
*SuppressionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource ID.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
}SuppressionContract the details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.
func (sc SuppressionContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SuppressionContract.
func (sc *SuppressionContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SuppressionContract struct.
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 (sclr SuppressionContractListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SuppressionContractListResultIterator struct {
// contains filtered or unexported fields
}SuppressionContractListResultIterator provides access to a complete listing of SuppressionContract values.
func NewSuppressionContractListResultIterator(page SuppressionContractListResultPage) SuppressionContractListResultIterator
Creates a new instance of the SuppressionContractListResultIterator type.
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. Deprecated: Use NextWithContext() instead.
func (iter *SuppressionContractListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SuppressionContractListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SuppressionContractListResultIterator) Response() SuppressionContractListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}SuppressionContractListResultPage contains a page of SuppressionContract values.
func NewSuppressionContractListResultPage(cur SuppressionContractListResult, getNextPage func(context.Context, SuppressionContractListResult) (SuppressionContractListResult, error)) SuppressionContractListResultPage
Creates a new instance of the SuppressionContractListResultPage type.
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. Deprecated: Use NextWithContext() instead.
func (page *SuppressionContractListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext 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 (page SuppressionContractListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SuppressionContractListResultPage) Response() SuppressionContractListResult
Response returns the raw server response from the last page request.
func (page SuppressionContractListResultPage) Values() []SuppressionContract
Values returns the slice of values for the current page or nil if there are no values.
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"`
// ExpirationTimeStamp - READ-ONLY; Gets or sets the expiration time stamp.
ExpirationTimeStamp *date.Time `json:"expirationTimeStamp,omitempty"`
}SuppressionProperties the properties of the suppression.
func (sp SuppressionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SuppressionProperties.
type SuppressionsClient struct {
BaseClient
}SuppressionsClient is the REST APIs for Azure Advisor
func NewSuppressionsClient(subscriptionID string) SuppressionsClient
NewSuppressionsClient creates an instance of the SuppressionsClient client.
func NewSuppressionsClientWithBaseURI(baseURI string, subscriptionID string) SuppressionsClient
NewSuppressionsClientWithBaseURI creates an instance of the SuppressionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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. Parameters: resourceURI - the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID - the recommendation ID. name - the name of the suppression. suppressionContract - the snoozed or dismissed attribute; for example, the snooze duration.
func (client SuppressionsClient) CreatePreparer(ctx context.Context, resourceURI string, recommendationID string, name string, suppressionContract SuppressionContract) (*http.Request, error)
CreatePreparer prepares the Create request.
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.
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
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. Parameters: resourceURI - the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID - the recommendation ID. name - the name of the suppression.
func (client SuppressionsClient) DeletePreparer(ctx context.Context, resourceURI string, recommendationID string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SuppressionsClient) Get(ctx context.Context, resourceURI string, recommendationID string, name string) (result SetObject, err error)
Get obtains the details of a suppression. Parameters: resourceURI - the fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. recommendationID - the recommendation ID. name - the name of the suppression.
func (client SuppressionsClient) GetPreparer(ctx context.Context, resourceURI string, recommendationID string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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. Parameters: top - the number of suppressions per page if a paged version of this API is being used. skipToken - the page-continuation token to use with a paged version of this API.
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 (client SuppressionsClient) ListPreparer(ctx context.Context, top *int32, skipToken string) (*http.Request, error)
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
| Path | Synopsis |
|---|---|
| advisorapi |
Package advisor imports 10 packages (graph) and is imported by 3 packages. Updated 2021-01-16. Refresh now. Tools for package owners.