README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/insights/2021-05-01-preview/autoscalesettings
Documentation
The autoscalesettings
SDK allows for interaction with the Azure Resource Manager Service insights
(API Version 2021-05-01-preview
).
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/insights/2021-05-01-preview/autoscalesettings"
Client Initialization
client := autoscalesettings.NewAutoScaleSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AutoScaleSettingsClient.CreateOrUpdate
ctx := context.TODO()
id := autoscalesettings.NewAutoScaleSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autoScaleSettingValue")
payload := autoscalesettings.AutoscaleSettingResource{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AutoScaleSettingsClient.Delete
ctx := context.TODO()
id := autoscalesettings.NewAutoScaleSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autoScaleSettingValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AutoScaleSettingsClient.Get
ctx := context.TODO()
id := autoscalesettings.NewAutoScaleSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autoScaleSettingValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AutoScaleSettingsClient.ListByResourceGroup
ctx := context.TODO()
id := autoscalesettings.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: AutoScaleSettingsClient.ListBySubscription
ctx := context.TODO()
id := autoscalesettings.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForComparisonOperationType() []string
- func PossibleValuesForMetricStatisticType() []string
- func PossibleValuesForOperationType() []string
- func PossibleValuesForPredictiveAutoscalePolicyScaleMode() []string
- func PossibleValuesForRecurrenceFrequency() []string
- func PossibleValuesForScaleDirection() []string
- func PossibleValuesForScaleRuleMetricDimensionOperationType() []string
- func PossibleValuesForScaleType() []string
- func PossibleValuesForTimeAggregationType() []string
- func ValidateAutoScaleSettingID(input interface{}, key string) (warnings []string, errors []error)
- type AutoScaleSettingId
- type AutoScaleSettingsClient
- func (c AutoScaleSettingsClient) CreateOrUpdate(ctx context.Context, id AutoScaleSettingId, input AutoscaleSettingResource) (result CreateOrUpdateOperationResponse, err error)
- func (c AutoScaleSettingsClient) Delete(ctx context.Context, id AutoScaleSettingId) (result DeleteOperationResponse, err error)
- func (c AutoScaleSettingsClient) Get(ctx context.Context, id AutoScaleSettingId) (result GetOperationResponse, err error)
- func (c AutoScaleSettingsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp ListByResourceGroupOperationResponse, err error)
- func (c AutoScaleSettingsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c AutoScaleSettingsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (resp ListByResourceGroupCompleteResult, err error)
- func (c AutoScaleSettingsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)
- func (c AutoScaleSettingsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
- func (c AutoScaleSettingsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp ListBySubscriptionCompleteResult, err error)
- type AutoscaleNotification
- type AutoscaleProfile
- type AutoscaleSetting
- type AutoscaleSettingResource
- type AutoscaleSettingResourceOperationPredicate
- type ComparisonOperationType
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type EmailNotification
- type GetOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationResponse
- type MetricStatisticType
- type MetricTrigger
- type OperationType
- type PredictiveAutoscalePolicy
- type PredictiveAutoscalePolicyScaleMode
- type Recurrence
- type RecurrenceFrequency
- type RecurrentSchedule
- type ScaleAction
- type ScaleCapacity
- type ScaleDirection
- type ScaleRule
- type ScaleRuleMetricDimension
- type ScaleRuleMetricDimensionOperationType
- type ScaleType
- type TimeAggregationType
- type TimeWindow
- type WebhookNotification
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForComparisonOperationType ¶
func PossibleValuesForComparisonOperationType() []string
func PossibleValuesForMetricStatisticType ¶
func PossibleValuesForMetricStatisticType() []string
func PossibleValuesForOperationType ¶
func PossibleValuesForOperationType() []string
func PossibleValuesForPredictiveAutoscalePolicyScaleMode ¶
func PossibleValuesForPredictiveAutoscalePolicyScaleMode() []string
func PossibleValuesForRecurrenceFrequency ¶
func PossibleValuesForRecurrenceFrequency() []string
func PossibleValuesForScaleDirection ¶
func PossibleValuesForScaleDirection() []string
func PossibleValuesForScaleRuleMetricDimensionOperationType ¶
func PossibleValuesForScaleRuleMetricDimensionOperationType() []string
func PossibleValuesForScaleType ¶
func PossibleValuesForScaleType() []string
func PossibleValuesForTimeAggregationType ¶
func PossibleValuesForTimeAggregationType() []string
func ValidateAutoScaleSettingID ¶
ValidateAutoScaleSettingID checks that 'input' can be parsed as a Auto Scale Setting ID
Types ¶
type AutoScaleSettingId ¶
type AutoScaleSettingId struct { SubscriptionId string ResourceGroupName string AutoScaleSettingName string }
AutoScaleSettingId is a struct representing the Resource ID for a Auto Scale Setting
func NewAutoScaleSettingID ¶
func NewAutoScaleSettingID(subscriptionId string, resourceGroupName string, autoScaleSettingName string) AutoScaleSettingId
NewAutoScaleSettingID returns a new AutoScaleSettingId struct
func ParseAutoScaleSettingID ¶
func ParseAutoScaleSettingID(input string) (*AutoScaleSettingId, error)
ParseAutoScaleSettingID parses 'input' into a AutoScaleSettingId
func ParseAutoScaleSettingIDInsensitively ¶
func ParseAutoScaleSettingIDInsensitively(input string) (*AutoScaleSettingId, error)
ParseAutoScaleSettingIDInsensitively parses 'input' case-insensitively into a AutoScaleSettingId note: this method should only be used for API response data and not user input
func (AutoScaleSettingId) ID ¶
func (id AutoScaleSettingId) ID() string
ID returns the formatted Auto Scale Setting ID
func (AutoScaleSettingId) Segments ¶
func (id AutoScaleSettingId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Auto Scale Setting ID
func (AutoScaleSettingId) String ¶
func (id AutoScaleSettingId) String() string
String returns a human-readable description of this Auto Scale Setting ID
type AutoScaleSettingsClient ¶
type AutoScaleSettingsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewAutoScaleSettingsClientWithBaseURI ¶
func NewAutoScaleSettingsClientWithBaseURI(endpoint string) AutoScaleSettingsClient
func (AutoScaleSettingsClient) CreateOrUpdate ¶
func (c AutoScaleSettingsClient) CreateOrUpdate(ctx context.Context, id AutoScaleSettingId, input AutoscaleSettingResource) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (AutoScaleSettingsClient) Delete ¶
func (c AutoScaleSettingsClient) Delete(ctx context.Context, id AutoScaleSettingId) (result DeleteOperationResponse, err error)
Delete ...
func (AutoScaleSettingsClient) Get ¶
func (c AutoScaleSettingsClient) Get(ctx context.Context, id AutoScaleSettingId) (result GetOperationResponse, err error)
Get ...
func (AutoScaleSettingsClient) ListByResourceGroup ¶
func (c AutoScaleSettingsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (resp ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (AutoScaleSettingsClient) ListByResourceGroupComplete ¶
func (c AutoScaleSettingsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all of the results into a single object
func (AutoScaleSettingsClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c AutoScaleSettingsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AutoscaleSettingResourceOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (AutoScaleSettingsClient) ListBySubscription ¶
func (c AutoScaleSettingsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (AutoScaleSettingsClient) ListBySubscriptionComplete ¶
func (c AutoScaleSettingsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all of the results into a single object
func (AutoScaleSettingsClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c AutoScaleSettingsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AutoscaleSettingResourceOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type AutoscaleNotification ¶
type AutoscaleNotification struct { Email *EmailNotification `json:"email,omitempty"` Operation OperationType `json:"operation"` WebHooks *[]WebhookNotification `json:"webhooks,omitempty"` }
type AutoscaleProfile ¶
type AutoscaleProfile struct { Capacity ScaleCapacity `json:"capacity"` FixedDate *TimeWindow `json:"fixedDate,omitempty"` Name string `json:"name"` Recurrence *Recurrence `json:"recurrence,omitempty"` Rules []ScaleRule `json:"rules"` }
type AutoscaleSetting ¶
type AutoscaleSetting struct { Enabled *bool `json:"enabled,omitempty"` Name *string `json:"name,omitempty"` Notifications *[]AutoscaleNotification `json:"notifications,omitempty"` PredictiveAutoscalePolicy *PredictiveAutoscalePolicy `json:"predictiveAutoscalePolicy,omitempty"` Profiles []AutoscaleProfile `json:"profiles"` TargetResourceLocation *string `json:"targetResourceLocation,omitempty"` TargetResourceUri *string `json:"targetResourceUri,omitempty"` }
type AutoscaleSettingResource ¶
type AutoscaleSettingResource struct { Id *string `json:"id,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties AutoscaleSetting `json:"properties"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type AutoscaleSettingResourceOperationPredicate ¶
type AutoscaleSettingResourceOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (AutoscaleSettingResourceOperationPredicate) Matches ¶
func (p AutoscaleSettingResourceOperationPredicate) Matches(input AutoscaleSettingResource) bool
type ComparisonOperationType ¶
type ComparisonOperationType string
const ( ComparisonOperationTypeEquals ComparisonOperationType = "Equals" ComparisonOperationTypeGreaterThan ComparisonOperationType = "GreaterThan" ComparisonOperationTypeGreaterThanOrEqual ComparisonOperationType = "GreaterThanOrEqual" ComparisonOperationTypeLessThan ComparisonOperationType = "LessThan" ComparisonOperationTypeLessThanOrEqual ComparisonOperationType = "LessThanOrEqual" ComparisonOperationTypeNotEquals ComparisonOperationType = "NotEquals" )
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *AutoscaleSettingResource }
type DeleteOperationResponse ¶
type EmailNotification ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *AutoscaleSettingResource }
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct {
Items []AutoscaleSettingResource
}
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response Model *[]AutoscaleSettingResource // contains filtered or unexported fields }
func (ListByResourceGroupOperationResponse) HasMore ¶
func (r ListByResourceGroupOperationResponse) HasMore() bool
func (ListByResourceGroupOperationResponse) LoadMore ¶
func (r ListByResourceGroupOperationResponse) LoadMore(ctx context.Context) (resp ListByResourceGroupOperationResponse, err error)
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct {
Items []AutoscaleSettingResource
}
type ListBySubscriptionOperationResponse ¶
type ListBySubscriptionOperationResponse struct { HttpResponse *http.Response Model *[]AutoscaleSettingResource // contains filtered or unexported fields }
func (ListBySubscriptionOperationResponse) HasMore ¶
func (r ListBySubscriptionOperationResponse) HasMore() bool
func (ListBySubscriptionOperationResponse) LoadMore ¶
func (r ListBySubscriptionOperationResponse) LoadMore(ctx context.Context) (resp ListBySubscriptionOperationResponse, err error)
type MetricStatisticType ¶
type MetricStatisticType string
const ( MetricStatisticTypeAverage MetricStatisticType = "Average" MetricStatisticTypeCount MetricStatisticType = "Count" MetricStatisticTypeMax MetricStatisticType = "Max" MetricStatisticTypeMin MetricStatisticType = "Min" MetricStatisticTypeSum MetricStatisticType = "Sum" )
type MetricTrigger ¶
type MetricTrigger struct { Dimensions *[]ScaleRuleMetricDimension `json:"dimensions,omitempty"` DividePerInstance *bool `json:"dividePerInstance,omitempty"` MetricName string `json:"metricName"` MetricNamespace *string `json:"metricNamespace,omitempty"` MetricResourceLocation *string `json:"metricResourceLocation,omitempty"` MetricResourceUri string `json:"metricResourceUri"` Operator ComparisonOperationType `json:"operator"` Statistic MetricStatisticType `json:"statistic"` Threshold float64 `json:"threshold"` TimeAggregation TimeAggregationType `json:"timeAggregation"` TimeGrain string `json:"timeGrain"` TimeWindow string `json:"timeWindow"` }
type PredictiveAutoscalePolicy ¶
type PredictiveAutoscalePolicy struct { ScaleLookAheadTime *string `json:"scaleLookAheadTime,omitempty"` ScaleMode PredictiveAutoscalePolicyScaleMode `json:"scaleMode"` }
type PredictiveAutoscalePolicyScaleMode ¶
type PredictiveAutoscalePolicyScaleMode string
const ( PredictiveAutoscalePolicyScaleModeDisabled PredictiveAutoscalePolicyScaleMode = "Disabled" PredictiveAutoscalePolicyScaleModeEnabled PredictiveAutoscalePolicyScaleMode = "Enabled" PredictiveAutoscalePolicyScaleModeForecastOnly PredictiveAutoscalePolicyScaleMode = "ForecastOnly" )
type Recurrence ¶
type Recurrence struct { Frequency RecurrenceFrequency `json:"frequency"` Schedule RecurrentSchedule `json:"schedule"` }
type RecurrenceFrequency ¶
type RecurrenceFrequency string
const ( RecurrenceFrequencyDay RecurrenceFrequency = "Day" RecurrenceFrequencyHour RecurrenceFrequency = "Hour" RecurrenceFrequencyMinute RecurrenceFrequency = "Minute" RecurrenceFrequencyMonth RecurrenceFrequency = "Month" RecurrenceFrequencyNone RecurrenceFrequency = "None" RecurrenceFrequencySecond RecurrenceFrequency = "Second" RecurrenceFrequencyWeek RecurrenceFrequency = "Week" RecurrenceFrequencyYear RecurrenceFrequency = "Year" )
type RecurrentSchedule ¶
type ScaleAction ¶
type ScaleAction struct { Cooldown string `json:"cooldown"` Direction ScaleDirection `json:"direction"` Type ScaleType `json:"type"` Value *string `json:"value,omitempty"` }
type ScaleCapacity ¶
type ScaleDirection ¶
type ScaleDirection string
const ( ScaleDirectionDecrease ScaleDirection = "Decrease" ScaleDirectionIncrease ScaleDirection = "Increase" ScaleDirectionNone ScaleDirection = "None" )
type ScaleRule ¶
type ScaleRule struct { MetricTrigger MetricTrigger `json:"metricTrigger"` ScaleAction ScaleAction `json:"scaleAction"` }
type ScaleRuleMetricDimension ¶
type ScaleRuleMetricDimension struct { DimensionName string `json:"DimensionName"` Operator ScaleRuleMetricDimensionOperationType `json:"Operator"` Values []string `json:"Values"` }
type ScaleRuleMetricDimensionOperationType ¶
type ScaleRuleMetricDimensionOperationType string
const ( ScaleRuleMetricDimensionOperationTypeEquals ScaleRuleMetricDimensionOperationType = "Equals" ScaleRuleMetricDimensionOperationTypeNotEquals ScaleRuleMetricDimensionOperationType = "NotEquals" )
type TimeAggregationType ¶
type TimeAggregationType string
const ( TimeAggregationTypeAverage TimeAggregationType = "Average" TimeAggregationTypeCount TimeAggregationType = "Count" TimeAggregationTypeLast TimeAggregationType = "Last" TimeAggregationTypeMaximum TimeAggregationType = "Maximum" TimeAggregationTypeMinimum TimeAggregationType = "Minimum" TimeAggregationTypeTotal TimeAggregationType = "Total" )
type TimeWindow ¶
type TimeWindow struct { End string `json:"end"` Start string `json:"start"` TimeZone *string `json:"timeZone,omitempty"` }
func (*TimeWindow) GetEndAsTime ¶
func (o *TimeWindow) GetEndAsTime() (*time.Time, error)
func (*TimeWindow) GetStartAsTime ¶
func (o *TimeWindow) GetStartAsTime() (*time.Time, error)
func (*TimeWindow) SetEndAsTime ¶
func (o *TimeWindow) SetEndAsTime(input time.Time)
func (*TimeWindow) SetStartAsTime ¶
func (o *TimeWindow) SetStartAsTime(input time.Time)
type WebhookNotification ¶
Source Files ¶
- client.go
- constants.go
- id_autoscalesetting.go
- method_createorupdate_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_listbyresourcegroup_autorest.go
- method_listbysubscription_autorest.go
- model_autoscalenotification.go
- model_autoscaleprofile.go
- model_autoscalesetting.go
- model_autoscalesettingresource.go
- model_emailnotification.go
- model_metrictrigger.go
- model_predictiveautoscalepolicy.go
- model_recurrence.go
- model_recurrentschedule.go
- model_scaleaction.go
- model_scalecapacity.go
- model_scalerule.go
- model_scalerulemetricdimension.go
- model_timewindow.go
- model_webhooknotification.go
- predicates.go
- version.go