README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-08-01/alerts
Documentation
The alerts
SDK allows for interaction with Azure Resource Manager costmanagement
(API Version 2023-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-08-01/alerts"
Client Initialization
client := alerts.NewAlertsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AlertsClient.Dismiss
ctx := context.TODO()
id := alerts.NewScopedAlertID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "alertId")
payload := alerts.DismissAlertPayload{
// ...
}
read, err := client.Dismiss(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: AlertsClient.Get
ctx := context.TODO()
id := alerts.NewScopedAlertID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "alertId")
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: AlertsClient.List
ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: AlertsClient.ListExternal
ctx := context.TODO()
id := alerts.NewExternalCloudProviderTypeID("externalBillingAccounts", "externalCloudProviderId")
// alternatively `client.ListExternal(ctx, id)` can be used to do batched pagination
items, err := client.ListExternalComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForAlertCategory() []string
- func PossibleValuesForAlertCriteria() []string
- func PossibleValuesForAlertOperator() []string
- func PossibleValuesForAlertSource() []string
- func PossibleValuesForAlertStatus() []string
- func PossibleValuesForAlertTimeGrainType() []string
- func PossibleValuesForAlertType() []string
- func PossibleValuesForExternalCloudProviderType() []string
- func ValidateExternalCloudProviderTypeID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateScopedAlertID(input interface{}, key string) (warnings []string, errors []error)
- type Alert
- type AlertCategory
- type AlertCriteria
- type AlertOperationPredicate
- type AlertOperator
- type AlertProperties
- type AlertPropertiesDefinition
- type AlertPropertiesDetails
- type AlertSource
- type AlertStatus
- type AlertTimeGrainType
- type AlertType
- type AlertsClient
- func (c AlertsClient) Dismiss(ctx context.Context, id ScopedAlertId, input DismissAlertPayload) (result DismissOperationResponse, err error)
- func (c AlertsClient) Get(ctx context.Context, id ScopedAlertId) (result GetOperationResponse, err error)
- func (c AlertsClient) List(ctx context.Context, id commonids.ScopeId) (result ListOperationResponse, err error)
- func (c AlertsClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)
- func (c AlertsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate AlertOperationPredicate) (result ListCompleteResult, err error)
- func (c AlertsClient) ListExternal(ctx context.Context, id ExternalCloudProviderTypeId) (result ListExternalOperationResponse, err error)
- func (c AlertsClient) ListExternalComplete(ctx context.Context, id ExternalCloudProviderTypeId) (ListExternalCompleteResult, error)
- func (c AlertsClient) ListExternalCompleteMatchingPredicate(ctx context.Context, id ExternalCloudProviderTypeId, ...) (result ListExternalCompleteResult, err error)
- type DismissAlertPayload
- type DismissOperationResponse
- type ExternalCloudProviderType
- type ExternalCloudProviderTypeId
- func NewExternalCloudProviderTypeID(externalCloudProviderType ExternalCloudProviderType, ...) ExternalCloudProviderTypeId
- func ParseExternalCloudProviderTypeID(input string) (*ExternalCloudProviderTypeId, error)
- func ParseExternalCloudProviderTypeIDInsensitively(input string) (*ExternalCloudProviderTypeId, error)
- type GetOperationResponse
- type ListCompleteResult
- type ListCustomPager
- type ListExternalCompleteResult
- type ListExternalCustomPager
- type ListExternalOperationResponse
- type ListOperationResponse
- type ScopedAlertId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForAlertCategory ¶
func PossibleValuesForAlertCategory() []string
func PossibleValuesForAlertCriteria ¶
func PossibleValuesForAlertCriteria() []string
func PossibleValuesForAlertOperator ¶
func PossibleValuesForAlertOperator() []string
func PossibleValuesForAlertSource ¶
func PossibleValuesForAlertSource() []string
func PossibleValuesForAlertStatus ¶
func PossibleValuesForAlertStatus() []string
func PossibleValuesForAlertTimeGrainType ¶
func PossibleValuesForAlertTimeGrainType() []string
func PossibleValuesForAlertType ¶
func PossibleValuesForAlertType() []string
func PossibleValuesForExternalCloudProviderType ¶
func PossibleValuesForExternalCloudProviderType() []string
func ValidateExternalCloudProviderTypeID ¶
func ValidateExternalCloudProviderTypeID(input interface{}, key string) (warnings []string, errors []error)
ValidateExternalCloudProviderTypeID checks that 'input' can be parsed as a External Cloud Provider Type ID
func ValidateScopedAlertID ¶
ValidateScopedAlertID checks that 'input' can be parsed as a Scoped Alert ID
Types ¶
type Alert ¶
type Alert struct { ETag *string `json:"eTag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *AlertProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type AlertCategory ¶
type AlertCategory string
const ( AlertCategoryBilling AlertCategory = "Billing" AlertCategoryCost AlertCategory = "Cost" AlertCategorySystem AlertCategory = "System" AlertCategoryUsage AlertCategory = "Usage" )
func (*AlertCategory) UnmarshalJSON ¶
func (s *AlertCategory) UnmarshalJSON(bytes []byte) error
type AlertCriteria ¶
type AlertCriteria string
const ( AlertCriteriaCostThresholdExceeded AlertCriteria = "CostThresholdExceeded" AlertCriteriaCreditThresholdApproaching AlertCriteria = "CreditThresholdApproaching" AlertCriteriaCreditThresholdReached AlertCriteria = "CreditThresholdReached" AlertCriteriaCrossCloudCollectionError AlertCriteria = "CrossCloudCollectionError" AlertCriteriaCrossCloudNewDataAvailable AlertCriteria = "CrossCloudNewDataAvailable" AlertCriteriaForecastCostThresholdExceeded AlertCriteria = "ForecastCostThresholdExceeded" AlertCriteriaForecastUsageThresholdExceeded AlertCriteria = "ForecastUsageThresholdExceeded" AlertCriteriaGeneralThresholdError AlertCriteria = "GeneralThresholdError" AlertCriteriaInvoiceDueDateApproaching AlertCriteria = "InvoiceDueDateApproaching" AlertCriteriaInvoiceDueDateReached AlertCriteria = "InvoiceDueDateReached" AlertCriteriaMultiCurrency AlertCriteria = "MultiCurrency" AlertCriteriaQuotaThresholdApproaching AlertCriteria = "QuotaThresholdApproaching" AlertCriteriaQuotaThresholdReached AlertCriteria = "QuotaThresholdReached" AlertCriteriaUsageThresholdExceeded AlertCriteria = "UsageThresholdExceeded" )
func (*AlertCriteria) UnmarshalJSON ¶
func (s *AlertCriteria) UnmarshalJSON(bytes []byte) error
type AlertOperationPredicate ¶
func (AlertOperationPredicate) Matches ¶
func (p AlertOperationPredicate) Matches(input Alert) bool
type AlertOperator ¶
type AlertOperator string
const ( AlertOperatorEqualTo AlertOperator = "EqualTo" AlertOperatorGreaterThan AlertOperator = "GreaterThan" AlertOperatorGreaterThanOrEqualTo AlertOperator = "GreaterThanOrEqualTo" AlertOperatorLessThan AlertOperator = "LessThan" AlertOperatorLessThanOrEqualTo AlertOperator = "LessThanOrEqualTo" AlertOperatorNone AlertOperator = "None" )
func (*AlertOperator) UnmarshalJSON ¶
func (s *AlertOperator) UnmarshalJSON(bytes []byte) error
type AlertProperties ¶
type AlertProperties struct { CloseTime *string `json:"closeTime,omitempty"` CostEntityId *string `json:"costEntityId,omitempty"` CreationTime *string `json:"creationTime,omitempty"` Definition *AlertPropertiesDefinition `json:"definition,omitempty"` Description *string `json:"description,omitempty"` Details *AlertPropertiesDetails `json:"details,omitempty"` ModificationTime *string `json:"modificationTime,omitempty"` Source *AlertSource `json:"source,omitempty"` Status *AlertStatus `json:"status,omitempty"` StatusModificationTime *string `json:"statusModificationTime,omitempty"` StatusModificationUserName *string `json:"statusModificationUserName,omitempty"` }
type AlertPropertiesDefinition ¶
type AlertPropertiesDefinition struct { Category *AlertCategory `json:"category,omitempty"` Criteria *AlertCriteria `json:"criteria,omitempty"` Type *AlertType `json:"type,omitempty"` }
type AlertPropertiesDetails ¶
type AlertPropertiesDetails struct { Amount *float64 `json:"amount,omitempty"` CompanyName *string `json:"companyName,omitempty"` ContactEmails *[]string `json:"contactEmails,omitempty"` ContactGroups *[]string `json:"contactGroups,omitempty"` ContactRoles *[]string `json:"contactRoles,omitempty"` CurrentSpend *float64 `json:"currentSpend,omitempty"` DepartmentName *string `json:"departmentName,omitempty"` EnrollmentEndDate *string `json:"enrollmentEndDate,omitempty"` EnrollmentNumber *string `json:"enrollmentNumber,omitempty"` EnrollmentStartDate *string `json:"enrollmentStartDate,omitempty"` InvoicingThreshold *float64 `json:"invoicingThreshold,omitempty"` MeterFilter *[]interface{} `json:"meterFilter,omitempty"` Operator *AlertOperator `json:"operator,omitempty"` OverridingAlert *string `json:"overridingAlert,omitempty"` PeriodStartDate *string `json:"periodStartDate,omitempty"` ResourceFilter *[]interface{} `json:"resourceFilter,omitempty"` ResourceGroupFilter *[]interface{} `json:"resourceGroupFilter,omitempty"` TagFilter *interface{} `json:"tagFilter,omitempty"` Threshold *float64 `json:"threshold,omitempty"` TimeGrainType *AlertTimeGrainType `json:"timeGrainType,omitempty"` TriggeredBy *string `json:"triggeredBy,omitempty"` Unit *string `json:"unit,omitempty"` }
type AlertSource ¶
type AlertSource string
const ( AlertSourcePreset AlertSource = "Preset" AlertSourceUser AlertSource = "User" )
func (*AlertSource) UnmarshalJSON ¶
func (s *AlertSource) UnmarshalJSON(bytes []byte) error
type AlertStatus ¶
type AlertStatus string
const ( AlertStatusActive AlertStatus = "Active" AlertStatusDismissed AlertStatus = "Dismissed" AlertStatusNone AlertStatus = "None" AlertStatusOverridden AlertStatus = "Overridden" AlertStatusResolved AlertStatus = "Resolved" )
func (*AlertStatus) UnmarshalJSON ¶
func (s *AlertStatus) UnmarshalJSON(bytes []byte) error
type AlertTimeGrainType ¶
type AlertTimeGrainType string
const ( AlertTimeGrainTypeAnnually AlertTimeGrainType = "Annually" AlertTimeGrainTypeBillingAnnual AlertTimeGrainType = "BillingAnnual" AlertTimeGrainTypeBillingMonth AlertTimeGrainType = "BillingMonth" AlertTimeGrainTypeBillingQuarter AlertTimeGrainType = "BillingQuarter" AlertTimeGrainTypeMonthly AlertTimeGrainType = "Monthly" AlertTimeGrainTypeNone AlertTimeGrainType = "None" AlertTimeGrainTypeQuarterly AlertTimeGrainType = "Quarterly" )
func (*AlertTimeGrainType) UnmarshalJSON ¶
func (s *AlertTimeGrainType) UnmarshalJSON(bytes []byte) error
type AlertsClient ¶
type AlertsClient struct {
Client *resourcemanager.Client
}
func NewAlertsClientWithBaseURI ¶
func NewAlertsClientWithBaseURI(sdkApi sdkEnv.Api) (*AlertsClient, error)
func (AlertsClient) Dismiss ¶
func (c AlertsClient) Dismiss(ctx context.Context, id ScopedAlertId, input DismissAlertPayload) (result DismissOperationResponse, err error)
Dismiss ...
func (AlertsClient) Get ¶
func (c AlertsClient) Get(ctx context.Context, id ScopedAlertId) (result GetOperationResponse, err error)
Get ...
func (AlertsClient) List ¶
func (c AlertsClient) List(ctx context.Context, id commonids.ScopeId) (result ListOperationResponse, err error)
List ...
func (AlertsClient) ListComplete ¶
func (c AlertsClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (AlertsClient) ListCompleteMatchingPredicate ¶
func (c AlertsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate AlertOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (AlertsClient) ListExternal ¶
func (c AlertsClient) ListExternal(ctx context.Context, id ExternalCloudProviderTypeId) (result ListExternalOperationResponse, err error)
ListExternal ...
func (AlertsClient) ListExternalComplete ¶
func (c AlertsClient) ListExternalComplete(ctx context.Context, id ExternalCloudProviderTypeId) (ListExternalCompleteResult, error)
ListExternalComplete retrieves all the results into a single object
func (AlertsClient) ListExternalCompleteMatchingPredicate ¶
func (c AlertsClient) ListExternalCompleteMatchingPredicate(ctx context.Context, id ExternalCloudProviderTypeId, predicate AlertOperationPredicate) (result ListExternalCompleteResult, err error)
ListExternalCompleteMatchingPredicate retrieves all the results and then applies the predicate
type DismissAlertPayload ¶
type DismissAlertPayload struct {
Properties *AlertProperties `json:"properties,omitempty"`
}
type ExternalCloudProviderType ¶
type ExternalCloudProviderType string
const ( ExternalCloudProviderTypeExternalBillingAccounts ExternalCloudProviderType = "externalBillingAccounts" ExternalCloudProviderTypeExternalSubscriptions ExternalCloudProviderType = "externalSubscriptions" )
func (*ExternalCloudProviderType) UnmarshalJSON ¶
func (s *ExternalCloudProviderType) UnmarshalJSON(bytes []byte) error
type ExternalCloudProviderTypeId ¶
type ExternalCloudProviderTypeId struct { ExternalCloudProviderType ExternalCloudProviderType ExternalCloudProviderId string }
ExternalCloudProviderTypeId is a struct representing the Resource ID for a External Cloud Provider Type
func NewExternalCloudProviderTypeID ¶
func NewExternalCloudProviderTypeID(externalCloudProviderType ExternalCloudProviderType, externalCloudProviderId string) ExternalCloudProviderTypeId
NewExternalCloudProviderTypeID returns a new ExternalCloudProviderTypeId struct
func ParseExternalCloudProviderTypeID ¶
func ParseExternalCloudProviderTypeID(input string) (*ExternalCloudProviderTypeId, error)
ParseExternalCloudProviderTypeID parses 'input' into a ExternalCloudProviderTypeId
func ParseExternalCloudProviderTypeIDInsensitively ¶
func ParseExternalCloudProviderTypeIDInsensitively(input string) (*ExternalCloudProviderTypeId, error)
ParseExternalCloudProviderTypeIDInsensitively parses 'input' case-insensitively into a ExternalCloudProviderTypeId note: this method should only be used for API response data and not user input
func (*ExternalCloudProviderTypeId) FromParseResult ¶
func (id *ExternalCloudProviderTypeId) FromParseResult(input resourceids.ParseResult) error
func (ExternalCloudProviderTypeId) ID ¶
func (id ExternalCloudProviderTypeId) ID() string
ID returns the formatted External Cloud Provider Type ID
func (ExternalCloudProviderTypeId) Segments ¶
func (id ExternalCloudProviderTypeId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this External Cloud Provider Type ID
func (ExternalCloudProviderTypeId) String ¶
func (id ExternalCloudProviderTypeId) String() string
String returns a human-readable description of this External Cloud Provider Type ID
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListCustomPager ¶
func (*ListCustomPager) NextPageLink ¶
func (p *ListCustomPager) NextPageLink() *odata.Link
type ListExternalCustomPager ¶
func (*ListExternalCustomPager) NextPageLink ¶
func (p *ListExternalCustomPager) NextPageLink() *odata.Link
type ListOperationResponse ¶
type ScopedAlertId ¶
ScopedAlertId is a struct representing the Resource ID for a Scoped Alert
func NewScopedAlertID ¶
func NewScopedAlertID(scope string, alertId string) ScopedAlertId
NewScopedAlertID returns a new ScopedAlertId struct
func ParseScopedAlertID ¶
func ParseScopedAlertID(input string) (*ScopedAlertId, error)
ParseScopedAlertID parses 'input' into a ScopedAlertId
func ParseScopedAlertIDInsensitively ¶
func ParseScopedAlertIDInsensitively(input string) (*ScopedAlertId, error)
ParseScopedAlertIDInsensitively parses 'input' case-insensitively into a ScopedAlertId note: this method should only be used for API response data and not user input
func (*ScopedAlertId) FromParseResult ¶
func (id *ScopedAlertId) FromParseResult(input resourceids.ParseResult) error
func (ScopedAlertId) ID ¶
func (id ScopedAlertId) ID() string
ID returns the formatted Scoped Alert ID
func (ScopedAlertId) Segments ¶
func (id ScopedAlertId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Scoped Alert ID
func (ScopedAlertId) String ¶
func (id ScopedAlertId) String() string
String returns a human-readable description of this Scoped Alert ID
Source Files ¶
- client.go
- constants.go
- id_externalcloudprovidertype.go
- id_scopedalert.go
- method_dismiss.go
- method_get.go
- method_list.go
- method_listexternal.go
- model_alert.go
- model_alertproperties.go
- model_alertpropertiesdefinition.go
- model_alertpropertiesdetails.go
- model_dismissalertpayload.go
- predicates.go
- version.go