...

Package scheduledqueryrules

import "github.com/Azure/azure-sdk-for-go/services/monitor/mgmt/2021-08-01/scheduledqueryrules"
Overview
Index
Subdirectories

Overview ▾

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package scheduledqueryrules implements the Azure ARM Scheduledqueryrules service API version 2021-08-01.

Monitor Management Client

Index ▾

Constants
func UserAgent() string
func Version() string
type Actions
    func (a Actions) MarshalJSON() ([]byte, error)
type AzureEntityResource
    func (aer AzureEntityResource) MarshalJSON() ([]byte, error)
type BaseClient
    func New(subscriptionID string) BaseClient
    func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
type Client
    func NewClient(subscriptionID string) Client
    func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
    func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourceType) (result ResourceType, err error)
    func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourceType) (*http.Request, error)
    func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ResourceType, err error)
    func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
    func (client Client) Delete(ctx context.Context, resourceGroupName string, ruleName string) (result autorest.Response, err error)
    func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, ruleName string) (*http.Request, error)
    func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
    func (client Client) DeleteSender(req *http.Request) (*http.Response, error)
    func (client Client) Get(ctx context.Context, resourceGroupName string, ruleName string) (result ResourceType, err error)
    func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, ruleName string) (*http.Request, error)
    func (client Client) GetResponder(resp *http.Response) (result ResourceType, err error)
    func (client Client) GetSender(req *http.Request) (*http.Response, error)
    func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ResourceCollectionPage, err error)
    func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ResourceCollectionIterator, err error)
    func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
    func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ResourceCollection, err error)
    func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
    func (client Client) ListBySubscription(ctx context.Context) (result ResourceCollectionPage, err error)
    func (client Client) ListBySubscriptionComplete(ctx context.Context) (result ResourceCollectionIterator, err error)
    func (client Client) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
    func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ResourceCollection, err error)
    func (client Client) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
    func (client Client) Update(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourcePatch) (result ResourceType, err error)
    func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourcePatch) (*http.Request, error)
    func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)
    func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
type Condition
type ConditionFailingPeriods
type ConditionOperator
    func PossibleConditionOperatorValues() []ConditionOperator
type CreatedByType
    func PossibleCreatedByTypeValues() []CreatedByType
type Criteria
type Dimension
type DimensionOperator
    func PossibleDimensionOperatorValues() []DimensionOperator
type ErrorAdditionalInfo
    func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
type ErrorContract
type ErrorResponse
    func (er ErrorResponse) MarshalJSON() ([]byte, error)
type Kind
    func PossibleKindValues() []Kind
type Properties
    func (p Properties) MarshalJSON() ([]byte, error)
type ProxyResource
    func (pr ProxyResource) MarshalJSON() ([]byte, error)
type Resource
    func (r Resource) MarshalJSON() ([]byte, error)
type ResourceCollection
    func (rc ResourceCollection) IsEmpty() bool
    func (rc ResourceCollection) MarshalJSON() ([]byte, error)
type ResourceCollectionIterator
    func NewResourceCollectionIterator(page ResourceCollectionPage) ResourceCollectionIterator
    func (iter *ResourceCollectionIterator) Next() error
    func (iter *ResourceCollectionIterator) NextWithContext(ctx context.Context) (err error)
    func (iter ResourceCollectionIterator) NotDone() bool
    func (iter ResourceCollectionIterator) Response() ResourceCollection
    func (iter ResourceCollectionIterator) Value() ResourceType
type ResourceCollectionPage
    func NewResourceCollectionPage(cur ResourceCollection, getNextPage func(context.Context, ResourceCollection) (ResourceCollection, error)) ResourceCollectionPage
    func (page *ResourceCollectionPage) Next() error
    func (page *ResourceCollectionPage) NextWithContext(ctx context.Context) (err error)
    func (page ResourceCollectionPage) NotDone() bool
    func (page ResourceCollectionPage) Response() ResourceCollection
    func (page ResourceCollectionPage) Values() []ResourceType
type ResourcePatch
    func (rp ResourcePatch) MarshalJSON() ([]byte, error)
    func (rp *ResourcePatch) UnmarshalJSON(body []byte) error
type ResourceType
    func (rt ResourceType) MarshalJSON() ([]byte, error)
    func (rt *ResourceType) UnmarshalJSON(body []byte) error
type SystemData
type TimeAggregation
    func PossibleTimeAggregationValues() []TimeAggregation
type TrackedResource
    func (tr TrackedResource) MarshalJSON() ([]byte, error)

Package files

client.go enums.go models.go scheduledqueryrules.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Scheduledqueryrules
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type Actions

Actions actions to invoke when the alert fires.

type Actions struct {
    // ActionGroups - Action Group resource Ids to invoke when the alert fires.
    ActionGroups *[]string `json:"actionGroups,omitempty"`
    // CustomProperties - The properties of an alert payload.
    CustomProperties map[string]*string `json:"customProperties"`
}

func (Actions) MarshalJSON

func (a Actions) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Actions.

type AzureEntityResource

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

type AzureEntityResource struct {
    // Etag - READ-ONLY; Resource Etag.
    Etag *string `json:"etag,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

func (AzureEntityResource) MarshalJSON

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient

BaseClient is the base client for Scheduledqueryrules.

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

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Client

Client is the monitor Management Client

type Client struct {
    BaseClient
}

func NewClient

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client 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) CreateOrUpdate

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourceType) (result ResourceType, err error)

CreateOrUpdate creates or updates a scheduled query rule. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. ruleName - the name of the rule. parameters - the parameters of the rule to create or update.

func (Client) CreateOrUpdatePreparer

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourceType) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ResourceType, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender

func (client Client) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (Client) Delete

func (client Client) Delete(ctx context.Context, resourceGroupName string, ruleName string) (result autorest.Response, err error)

Delete deletes a scheduled query rule. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. ruleName - the name of the rule.

func (Client) DeletePreparer

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, ruleName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender

func (client Client) DeleteSender(req *http.Request) (*http.Response, error)

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

func (Client) Get

func (client Client) Get(ctx context.Context, resourceGroupName string, ruleName string) (result ResourceType, err error)

Get retrieve an scheduled query rule definition. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. ruleName - the name of the rule.

func (Client) GetPreparer

func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, ruleName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result ResourceType, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender

func (client Client) GetSender(req *http.Request) (*http.Response, error)

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

func (Client) ListByResourceGroup

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ResourceCollectionPage, err error)

ListByResourceGroup retrieve scheduled query rule definitions in a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (Client) ListByResourceGroupComplete

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ResourceCollectionIterator, err error)

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

func (Client) ListByResourceGroupPreparer

func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ResourceCollection, err error)

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

func (Client) ListByResourceGroupSender

func (client Client) 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) ListBySubscription

func (client Client) ListBySubscription(ctx context.Context) (result ResourceCollectionPage, err error)

ListBySubscription retrieve a scheduled query rule definitions in a subscription.

func (Client) ListBySubscriptionComplete

func (client Client) ListBySubscriptionComplete(ctx context.Context) (result ResourceCollectionIterator, err error)

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

func (Client) ListBySubscriptionPreparer

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (Client) ListBySubscriptionResponder

func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ResourceCollection, err error)

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

func (Client) ListBySubscriptionSender

func (client Client) 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.

func (Client) Update

func (client Client) Update(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourcePatch) (result ResourceType, err error)

Update update a scheduled query rule. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. ruleName - the name of the rule. parameters - the parameters of the rule to update.

func (Client) UpdatePreparer

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, ruleName string, parameters ResourcePatch) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder

func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender

func (client Client) UpdateSender(req *http.Request) (*http.Response, error)

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

type Condition

Condition a condition of the scheduled query rule.

type Condition struct {
    // Query - Log query alert
    Query *string `json:"query,omitempty"`
    // TimeAggregation - Aggregation type. Relevant and required only for rules of the kind LogAlert. Possible values include: 'TimeAggregationCount', 'TimeAggregationAverage', 'TimeAggregationMinimum', 'TimeAggregationMaximum', 'TimeAggregationTotal'
    TimeAggregation TimeAggregation `json:"timeAggregation,omitempty"`
    // MetricMeasureColumn - The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
    MetricMeasureColumn *string `json:"metricMeasureColumn,omitempty"`
    // ResourceIDColumn - The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
    ResourceIDColumn *string `json:"resourceIdColumn,omitempty"`
    // Dimensions - List of Dimensions conditions
    Dimensions *[]Dimension `json:"dimensions,omitempty"`
    // Operator - The criteria operator. Relevant and required only for rules of the kind LogAlert. Possible values include: 'ConditionOperatorEquals', 'ConditionOperatorGreaterThan', 'ConditionOperatorGreaterThanOrEqual', 'ConditionOperatorLessThan', 'ConditionOperatorLessThanOrEqual'
    Operator ConditionOperator `json:"operator,omitempty"`
    // Threshold - the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
    Threshold *float64 `json:"threshold,omitempty"`
    // FailingPeriods - The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
    FailingPeriods *ConditionFailingPeriods `json:"failingPeriods,omitempty"`
    // MetricName - The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
    MetricName *string `json:"metricName,omitempty"`
}

type ConditionFailingPeriods

ConditionFailingPeriods the minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.

type ConditionFailingPeriods struct {
    // NumberOfEvaluationPeriods - The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1
    NumberOfEvaluationPeriods *int64 `json:"numberOfEvaluationPeriods,omitempty"`
    // MinFailingPeriodsToAlert - The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
    MinFailingPeriodsToAlert *int64 `json:"minFailingPeriodsToAlert,omitempty"`
}

type ConditionOperator

ConditionOperator enumerates the values for condition operator.

type ConditionOperator string
const (
    // ConditionOperatorEquals ...
    ConditionOperatorEquals ConditionOperator = "Equals"
    // ConditionOperatorGreaterThan ...
    ConditionOperatorGreaterThan ConditionOperator = "GreaterThan"
    // ConditionOperatorGreaterThanOrEqual ...
    ConditionOperatorGreaterThanOrEqual ConditionOperator = "GreaterThanOrEqual"
    // ConditionOperatorLessThan ...
    ConditionOperatorLessThan ConditionOperator = "LessThan"
    // ConditionOperatorLessThanOrEqual ...
    ConditionOperatorLessThanOrEqual ConditionOperator = "LessThanOrEqual"
)

func PossibleConditionOperatorValues

func PossibleConditionOperatorValues() []ConditionOperator

PossibleConditionOperatorValues returns an array of possible values for the ConditionOperator const type.

type CreatedByType

CreatedByType enumerates the values for created by type.

type CreatedByType string
const (
    // CreatedByTypeApplication ...
    CreatedByTypeApplication CreatedByType = "Application"
    // CreatedByTypeKey ...
    CreatedByTypeKey CreatedByType = "Key"
    // CreatedByTypeManagedIdentity ...
    CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
    // CreatedByTypeUser ...
    CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type Criteria

Criteria the rule criteria that defines the conditions of the scheduled query rule.

type Criteria struct {
    // AllOf - A list of conditions to evaluate against the specified scopes
    AllOf *[]Condition `json:"allOf,omitempty"`
}

type Dimension

Dimension dimension splitting and filtering definition

type Dimension struct {
    // Name - Name of the dimension
    Name *string `json:"name,omitempty"`
    // Operator - Operator for dimension values. Possible values include: 'DimensionOperatorInclude', 'DimensionOperatorExclude'
    Operator DimensionOperator `json:"operator,omitempty"`
    // Values - List of dimension values
    Values *[]string `json:"values,omitempty"`
}

type DimensionOperator

DimensionOperator enumerates the values for dimension operator.

type DimensionOperator string
const (
    // DimensionOperatorExclude ...
    DimensionOperatorExclude DimensionOperator = "Exclude"
    // DimensionOperatorInclude ...
    DimensionOperatorInclude DimensionOperator = "Include"
)

func PossibleDimensionOperatorValues

func PossibleDimensionOperatorValues() []DimensionOperator

PossibleDimensionOperatorValues returns an array of possible values for the DimensionOperator const type.

type ErrorAdditionalInfo

ErrorAdditionalInfo the resource management error additional info.

type ErrorAdditionalInfo struct {
    // Type - READ-ONLY; The additional info type.
    Type *string `json:"type,omitempty"`
    // Info - READ-ONLY; The additional info.
    Info interface{} `json:"info,omitempty"`
}

func (ErrorAdditionalInfo) MarshalJSON

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorContract

ErrorContract describes the format of Error response.

type ErrorContract struct {
    // Error - The error details.
    Error *ErrorResponse `json:"error,omitempty"`
}

type ErrorResponse

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

type ErrorResponse struct {
    // Code - READ-ONLY; The error code.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; The error message.
    Message *string `json:"message,omitempty"`
    // Target - READ-ONLY; The error target.
    Target *string `json:"target,omitempty"`
    // Details - READ-ONLY; The error details.
    Details *[]ErrorResponse `json:"details,omitempty"`
    // AdditionalInfo - READ-ONLY; The error additional info.
    AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

func (ErrorResponse) MarshalJSON

func (er ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponse.

type Kind

Kind enumerates the values for kind.

type Kind string
const (
    // KindLogAlert ...
    KindLogAlert Kind = "LogAlert"
    // KindLogToMetric ...
    KindLogToMetric Kind = "LogToMetric"
)

func PossibleKindValues

func PossibleKindValues() []Kind

PossibleKindValues returns an array of possible values for the Kind const type.

type Properties

Properties scheduled query rule Definition

type Properties struct {
    // CreatedWithAPIVersion - READ-ONLY; The api-version used when creating this alert rule
    CreatedWithAPIVersion *string `json:"createdWithApiVersion,omitempty"`
    // IsLegacyLogAnalyticsRule - READ-ONLY; True if alert rule is legacy Log Analytic rule
    IsLegacyLogAnalyticsRule *bool `json:"isLegacyLogAnalyticsRule,omitempty"`
    // Description - The description of the scheduled query rule.
    Description *string `json:"description,omitempty"`
    // DisplayName - The display name of the alert rule
    DisplayName *string `json:"displayName,omitempty"`
    // Severity - Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
    Severity *int64 `json:"severity,omitempty"`
    // Enabled - The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
    Enabled *bool `json:"enabled,omitempty"`
    // Scopes - The list of resource id's that this scheduled query rule is scoped to.
    Scopes *[]string `json:"scopes,omitempty"`
    // EvaluationFrequency - How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
    EvaluationFrequency *string `json:"evaluationFrequency,omitempty"`
    // WindowSize - The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.
    WindowSize *string `json:"windowSize,omitempty"`
    // OverrideQueryTimeRange - If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
    OverrideQueryTimeRange *string `json:"overrideQueryTimeRange,omitempty"`
    // TargetResourceTypes - List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
    TargetResourceTypes *[]string `json:"targetResourceTypes,omitempty"`
    // Criteria - The rule criteria that defines the conditions of the scheduled query rule.
    Criteria *Criteria `json:"criteria,omitempty"`
    // MuteActionsDuration - Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
    MuteActionsDuration *string `json:"muteActionsDuration,omitempty"`
    // Actions - Actions to invoke when the alert fires.
    Actions *Actions `json:"actions,omitempty"`
    // IsWorkspaceAlertsStorageConfigured - READ-ONLY; The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
    IsWorkspaceAlertsStorageConfigured *bool `json:"isWorkspaceAlertsStorageConfigured,omitempty"`
    // CheckWorkspaceAlertsStorageConfigured - The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
    CheckWorkspaceAlertsStorageConfigured *bool `json:"checkWorkspaceAlertsStorageConfigured,omitempty"`
    // SkipQueryValidation - The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
    SkipQueryValidation *bool `json:"skipQueryValidation,omitempty"`
    // AutoMitigate - The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
    AutoMitigate *bool `json:"autoMitigate,omitempty"`
}

func (Properties) MarshalJSON

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type ProxyResource

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type ProxyResource struct {
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource

Resource common fields that are returned in the response for all Azure Resource Manager resources

type Resource struct {
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceCollection

ResourceCollection represents a collection of scheduled query rule resources.

type ResourceCollection struct {
    autorest.Response `json:"-"`
    // Value - The values for the scheduled query rule resources.
    Value *[]ResourceType `json:"value,omitempty"`
    // NextLink - READ-ONLY; Provides the link to retrieve the next set of elements.
    NextLink *string `json:"nextLink,omitempty"`
}

func (ResourceCollection) IsEmpty

func (rc ResourceCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ResourceCollection) MarshalJSON

func (rc ResourceCollection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceCollection.

type ResourceCollectionIterator

ResourceCollectionIterator provides access to a complete listing of ResourceType values.

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

func NewResourceCollectionIterator

func NewResourceCollectionIterator(page ResourceCollectionPage) ResourceCollectionIterator

Creates a new instance of the ResourceCollectionIterator type.

func (*ResourceCollectionIterator) Next

func (iter *ResourceCollectionIterator) 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 (*ResourceCollectionIterator) NextWithContext

func (iter *ResourceCollectionIterator) 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 (ResourceCollectionIterator) NotDone

func (iter ResourceCollectionIterator) NotDone() bool

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

func (ResourceCollectionIterator) Response

func (iter ResourceCollectionIterator) Response() ResourceCollection

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

func (ResourceCollectionIterator) Value

func (iter ResourceCollectionIterator) Value() ResourceType

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

type ResourceCollectionPage

ResourceCollectionPage contains a page of ResourceType values.

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

func NewResourceCollectionPage

func NewResourceCollectionPage(cur ResourceCollection, getNextPage func(context.Context, ResourceCollection) (ResourceCollection, error)) ResourceCollectionPage

Creates a new instance of the ResourceCollectionPage type.

func (*ResourceCollectionPage) Next

func (page *ResourceCollectionPage) 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 (*ResourceCollectionPage) NextWithContext

func (page *ResourceCollectionPage) 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 (ResourceCollectionPage) NotDone

func (page ResourceCollectionPage) NotDone() bool

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

func (ResourceCollectionPage) Response

func (page ResourceCollectionPage) Response() ResourceCollection

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

func (ResourceCollectionPage) Values

func (page ResourceCollectionPage) Values() []ResourceType

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

type ResourcePatch

ResourcePatch the scheduled query rule resource for patch operations.

type ResourcePatch struct {
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
    // Properties - The scheduled query rule properties of the resource.
    *Properties `json:"properties,omitempty"`
}

func (ResourcePatch) MarshalJSON

func (rp ResourcePatch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourcePatch.

func (*ResourcePatch) UnmarshalJSON

func (rp *ResourcePatch) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourcePatch struct.

type ResourceType

ResourceType the scheduled query rule resource.

type ResourceType struct {
    autorest.Response `json:"-"`
    // Kind - Indicates the type of scheduled query rule. The default is LogAlert. Possible values include: 'KindLogAlert', 'KindLogToMetric'
    Kind Kind `json:"kind,omitempty"`
    // Etag - READ-ONLY; The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    Etag *string `json:"etag,omitempty"`
    // SystemData - READ-ONLY; SystemData of ScheduledQueryRule.
    SystemData *SystemData `json:"systemData,omitempty"`
    // Properties - The rule properties of the resource.
    *Properties `json:"properties,omitempty"`
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

func (ResourceType) MarshalJSON

func (rt ResourceType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceType.

func (*ResourceType) UnmarshalJSON

func (rt *ResourceType) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceType struct.

type SystemData

SystemData metadata pertaining to creation and last modification of the resource.

type SystemData struct {
    // CreatedBy - The identity that created the resource.
    CreatedBy *string `json:"createdBy,omitempty"`
    // CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
    CreatedByType CreatedByType `json:"createdByType,omitempty"`
    // CreatedAt - The timestamp of resource creation (UTC).
    CreatedAt *date.Time `json:"createdAt,omitempty"`
    // LastModifiedBy - The identity that last modified the resource.
    LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
    // LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
    LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
    // LastModifiedAt - The timestamp of resource last modification (UTC)
    LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

type TimeAggregation

TimeAggregation enumerates the values for time aggregation.

type TimeAggregation string
const (
    // TimeAggregationAverage ...
    TimeAggregationAverage TimeAggregation = "Average"
    // TimeAggregationCount ...
    TimeAggregationCount TimeAggregation = "Count"
    // TimeAggregationMaximum ...
    TimeAggregationMaximum TimeAggregation = "Maximum"
    // TimeAggregationMinimum ...
    TimeAggregationMinimum TimeAggregation = "Minimum"
    // TimeAggregationTotal ...
    TimeAggregationTotal TimeAggregation = "Total"
)

func PossibleTimeAggregationValues

func PossibleTimeAggregationValues() []TimeAggregation

PossibleTimeAggregationValues returns an array of possible values for the TimeAggregation const type.

type TrackedResource

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

type TrackedResource struct {
    // Tags - Resource tags.
    Tags map[string]*string `json:"tags"`
    // Location - The geo-location where the resource lives
    Location *string `json:"location,omitempty"`
    // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Type *string `json:"type,omitempty"`
}

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

Subdirectories

Name Synopsis
..
scheduledqueryrulesapi Deprecated: Please note, this package has been deprecated.