README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/advisor/2023-01-01/getrecommendations
Documentation
The getrecommendations
SDK allows for interaction with the Azure Resource Manager Service advisor
(API Version 2023-01-01
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/advisor/2023-01-01/getrecommendations"
Client Initialization
client := getrecommendations.NewGetRecommendationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: GetRecommendationsClient.RecommendationsGet
ctx := context.TODO()
id := getrecommendations.NewScopedRecommendationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "recommendationIdValue")
read, err := client.RecommendationsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: GetRecommendationsClient.RecommendationsList
ctx := context.TODO()
id := getrecommendations.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.RecommendationsList(ctx, id, getrecommendations.DefaultRecommendationsListOperationOptions())` can be used to do batched pagination
items, err := client.RecommendationsListComplete(ctx, id, getrecommendations.DefaultRecommendationsListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForCategory() []string
- func PossibleValuesForImpact() []string
- func PossibleValuesForRisk() []string
- func ValidateScopedRecommendationID(input interface{}, key string) (warnings []string, errors []error)
- type Category
- type GetRecommendationsClient
- func (c GetRecommendationsClient) RecommendationsGet(ctx context.Context, id ScopedRecommendationId) (result RecommendationsGetOperationResponse, err error)
- func (c GetRecommendationsClient) RecommendationsList(ctx context.Context, id commonids.SubscriptionId, ...) (resp RecommendationsListOperationResponse, err error)
- func (c GetRecommendationsClient) RecommendationsListComplete(ctx context.Context, id commonids.SubscriptionId, ...) (RecommendationsListCompleteResult, error)
- func (c GetRecommendationsClient) RecommendationsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp RecommendationsListCompleteResult, err error)
- type Impact
- type RecommendationProperties
- type RecommendationsGetOperationResponse
- type RecommendationsListCompleteResult
- type RecommendationsListOperationOptions
- type RecommendationsListOperationResponse
- type ResourceMetadata
- type ResourceRecommendationBase
- type ResourceRecommendationBaseOperationPredicate
- type Risk
- type ScopedRecommendationId
- type ShortDescription
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForCategory ¶
func PossibleValuesForCategory() []string
func PossibleValuesForImpact ¶
func PossibleValuesForImpact() []string
func PossibleValuesForRisk ¶
func PossibleValuesForRisk() []string
func ValidateScopedRecommendationID ¶
func ValidateScopedRecommendationID(input interface{}, key string) (warnings []string, errors []error)
ValidateScopedRecommendationID checks that 'input' can be parsed as a Scoped Recommendation ID
Types ¶
type GetRecommendationsClient ¶
type GetRecommendationsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewGetRecommendationsClientWithBaseURI ¶
func NewGetRecommendationsClientWithBaseURI(endpoint string) GetRecommendationsClient
func (GetRecommendationsClient) RecommendationsGet ¶
func (c GetRecommendationsClient) RecommendationsGet(ctx context.Context, id ScopedRecommendationId) (result RecommendationsGetOperationResponse, err error)
RecommendationsGet ...
func (GetRecommendationsClient) RecommendationsList ¶
func (c GetRecommendationsClient) RecommendationsList(ctx context.Context, id commonids.SubscriptionId, options RecommendationsListOperationOptions) (resp RecommendationsListOperationResponse, err error)
RecommendationsList ...
func (GetRecommendationsClient) RecommendationsListComplete ¶
func (c GetRecommendationsClient) RecommendationsListComplete(ctx context.Context, id commonids.SubscriptionId, options RecommendationsListOperationOptions) (RecommendationsListCompleteResult, error)
RecommendationsListComplete retrieves all of the results into a single object
func (GetRecommendationsClient) RecommendationsListCompleteMatchingPredicate ¶
func (c GetRecommendationsClient) RecommendationsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options RecommendationsListOperationOptions, predicate ResourceRecommendationBaseOperationPredicate) (resp RecommendationsListCompleteResult, err error)
RecommendationsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type RecommendationProperties ¶
type RecommendationProperties struct { Actions *[]map[string]interface{} `json:"actions,omitempty"` Category *Category `json:"category,omitempty"` Description *string `json:"description,omitempty"` ExposedMetadataProperties *map[string]interface{} `json:"exposedMetadataProperties,omitempty"` ExtendedProperties *map[string]string `json:"extendedProperties,omitempty"` Impact *Impact `json:"impact,omitempty"` ImpactedField *string `json:"impactedField,omitempty"` ImpactedValue *string `json:"impactedValue,omitempty"` Label *string `json:"label,omitempty"` LastUpdated *string `json:"lastUpdated,omitempty"` LearnMoreLink *string `json:"learnMoreLink,omitempty"` Metadata *map[string]interface{} `json:"metadata,omitempty"` PotentialBenefits *string `json:"potentialBenefits,omitempty"` RecommendationTypeId *string `json:"recommendationTypeId,omitempty"` Remediation *map[string]interface{} `json:"remediation,omitempty"` ResourceMetadata *ResourceMetadata `json:"resourceMetadata,omitempty"` Risk *Risk `json:"risk,omitempty"` ShortDescription *ShortDescription `json:"shortDescription,omitempty"` SuppressionIds *[]string `json:"suppressionIds,omitempty"` }
func (*RecommendationProperties) GetLastUpdatedAsTime ¶
func (o *RecommendationProperties) GetLastUpdatedAsTime() (*time.Time, error)
func (*RecommendationProperties) SetLastUpdatedAsTime ¶
func (o *RecommendationProperties) SetLastUpdatedAsTime(input time.Time)
type RecommendationsGetOperationResponse ¶
type RecommendationsGetOperationResponse struct { HttpResponse *http.Response Model *ResourceRecommendationBase }
type RecommendationsListCompleteResult ¶
type RecommendationsListCompleteResult struct {
Items []ResourceRecommendationBase
}
type RecommendationsListOperationOptions ¶
func DefaultRecommendationsListOperationOptions ¶
func DefaultRecommendationsListOperationOptions() RecommendationsListOperationOptions
type RecommendationsListOperationResponse ¶
type RecommendationsListOperationResponse struct { HttpResponse *http.Response Model *[]ResourceRecommendationBase // contains filtered or unexported fields }
func (RecommendationsListOperationResponse) HasMore ¶
func (r RecommendationsListOperationResponse) HasMore() bool
func (RecommendationsListOperationResponse) LoadMore ¶
func (r RecommendationsListOperationResponse) LoadMore(ctx context.Context) (resp RecommendationsListOperationResponse, err error)
type ResourceMetadata ¶
type ResourceRecommendationBase ¶
type ResourceRecommendationBase struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *RecommendationProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type ResourceRecommendationBaseOperationPredicate ¶
func (ResourceRecommendationBaseOperationPredicate) Matches ¶
func (p ResourceRecommendationBaseOperationPredicate) Matches(input ResourceRecommendationBase) bool
type ScopedRecommendationId ¶
ScopedRecommendationId is a struct representing the Resource ID for a Scoped Recommendation
func NewScopedRecommendationID ¶
func NewScopedRecommendationID(resourceUri string, recommendationId string) ScopedRecommendationId
NewScopedRecommendationID returns a new ScopedRecommendationId struct
func ParseScopedRecommendationID ¶
func ParseScopedRecommendationID(input string) (*ScopedRecommendationId, error)
ParseScopedRecommendationID parses 'input' into a ScopedRecommendationId
func ParseScopedRecommendationIDInsensitively ¶
func ParseScopedRecommendationIDInsensitively(input string) (*ScopedRecommendationId, error)
ParseScopedRecommendationIDInsensitively parses 'input' case-insensitively into a ScopedRecommendationId note: this method should only be used for API response data and not user input
func (ScopedRecommendationId) ID ¶
func (id ScopedRecommendationId) ID() string
ID returns the formatted Scoped Recommendation ID
func (ScopedRecommendationId) Segments ¶
func (id ScopedRecommendationId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Scoped Recommendation ID
func (ScopedRecommendationId) String ¶
func (id ScopedRecommendationId) String() string
String returns a human-readable description of this Scoped Recommendation ID