insights.azure.com/v1api20220615
APIVersion
| Value | Description |
|---|---|
| “2022-06-15” |
ScheduledQueryRule
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
Used by: ScheduledQueryRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | ScheduledQueryRule_Spec Optional |
|
| status | ScheduledQueryRule_STATUS Optional |
ScheduledQueryRule_Spec
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions Optional |
| 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. | bool Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| 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. | bool Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ScheduledQueryRuleOperatorSpec Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| scopesReferences | The list of resource id’s that this scheduled query rule is scoped to. | genruntime.ResourceReference[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity Optional |
| 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. | bool Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| 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. | string Optional |
ScheduledQueryRule_STATUS
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions_STATUS Optional |
| 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. | bool Optional |
| 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. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdWithApiVersion | The api-version used when creating this alert rule | string Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria_STATUS Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| etag | 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. | string Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isLegacyLogAnalyticsRule | True if alert rule is legacy Log Analytic rule | bool Optional |
| isWorkspaceAlertsStorageConfigured | The flag which indicates whether this scheduled query rule has been configured to be stored in the customer’s storage. The default is false. | bool Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| name | The name of the resource | string Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| scopes | The list of resource id’s that this scheduled query rule is scoped to. | string[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity_STATUS Optional |
| 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. | bool Optional |
| systemData | SystemData of ScheduledQueryRule. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| 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. | string Optional |
ScheduledQueryRuleList
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | ScheduledQueryRule[] Optional |
Webtest
Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/webTests_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/webtests/{webTestName}
Used by: WebtestList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Webtest_Spec Optional |
|
| status | Webtest_STATUS Optional |
Webtest_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| Configuration | An XML configuration specification for a WebTest. | WebTestProperties_Configuration Optional |
| Description | User defined description for this WebTest. | string Optional |
| Enabled | Is the test actively being monitored. | bool Optional |
| Frequency | Interval in seconds between test runs for this WebTest. Default value is 300. | int Optional |
| Kind | The kind of web test this is, valid choices are ping, multistep and standard. | WebTestProperties_Kind Required |
| location | Resource location | string Required |
| Locations | A list of where to physically run the tests from to give global coverage for accessibility of your application. | WebTestGeolocation[] Required |
| Name | User defined name if this WebTest. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WebtestOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| Request | The collection of request properties | WebTestProperties_Request Optional |
| RetryEnabled | Allow for retries should this WebTest fail. | bool Optional |
| SyntheticMonitorId | Unique ID of this WebTest. This is typically the same value as the Name field. | string Required |
| tags | Resource tags | map[string]string Optional |
| Timeout | Seconds until this WebTest will timeout and fail. Default value is 30. | int Optional |
| ValidationRules | The collection of validation rule properties | WebTestProperties_ValidationRules Optional |
Webtest_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| Configuration | An XML configuration specification for a WebTest. | WebTestProperties_Configuration_STATUS Optional |
| Description | User defined description for this WebTest. | string Optional |
| Enabled | Is the test actively being monitored. | bool Optional |
| Frequency | Interval in seconds between test runs for this WebTest. Default value is 300. | int Optional |
| id | Azure resource Id | string Optional |
| Kind | The kind of web test this is, valid choices are ping, multistep and standard. | WebTestProperties_Kind_STATUS Optional |
| location | Resource location | string Optional |
| Locations | A list of where to physically run the tests from to give global coverage for accessibility of your application. | WebTestGeolocation_STATUS[] Optional |
| name | Azure resource name | string Optional |
| properties_name | User defined name if this WebTest. | string Optional |
| provisioningState | Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. | string Optional |
| Request | The collection of request properties | WebTestProperties_Request_STATUS Optional |
| RetryEnabled | Allow for retries should this WebTest fail. | bool Optional |
| SyntheticMonitorId | Unique ID of this WebTest. This is typically the same value as the Name field. | string Optional |
| tags | Resource tags | map[string]string Optional |
| Timeout | Seconds until this WebTest will timeout and fail. Default value is 30. | int Optional |
| type | Azure resource type | string Optional |
| ValidationRules | The collection of validation rule properties | WebTestProperties_ValidationRules_STATUS Optional |
WebtestList
Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/webTests_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/webtests/{webTestName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Webtest[] Optional |
ScheduledQueryRule_Spec
Used by: ScheduledQueryRule.
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions Optional |
| 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. | bool Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| 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. | bool Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| 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. | string Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ScheduledQueryRuleOperatorSpec Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| scopesReferences | The list of resource id’s that this scheduled query rule is scoped to. | genruntime.ResourceReference[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity Optional |
| 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. | bool Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| 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. | string Optional |
ScheduledQueryRule_STATUS
Used by: ScheduledQueryRule.
| Property | Description | Type |
|---|---|---|
| actions | Actions to invoke when the alert fires. | Actions_STATUS Optional |
| 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. | bool Optional |
| 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. | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdWithApiVersion | The api-version used when creating this alert rule | string Optional |
| criteria | The rule criteria that defines the conditions of the scheduled query rule. | ScheduledQueryRuleCriteria_STATUS Optional |
| description | The description of the scheduled query rule. | string Optional |
| displayName | The display name of the alert rule | string Optional |
| enabled | The flag which indicates whether this scheduled query rule is enabled. Value should be true or false | bool Optional |
| etag | 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. | string Optional |
| 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. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isLegacyLogAnalyticsRule | True if alert rule is legacy Log Analytic rule | bool Optional |
| isWorkspaceAlertsStorageConfigured | The flag which indicates whether this scheduled query rule has been configured to be stored in the customer’s storage. The default is false. | bool Optional |
| kind | Indicates the type of scheduled query rule. The default is LogAlert. | ScheduledQueryRule_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| name | The name of the resource | string Optional |
| overrideQueryTimeRange | If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. | string Optional |
| scopes | The list of resource id’s that this scheduled query rule is scoped to. | string[] Optional |
| 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. | ScheduledQueryRuleProperties_Severity_STATUS Optional |
| 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. | bool Optional |
| systemData | SystemData of ScheduledQueryRule. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| 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 | string[] Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| 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. | string Optional |
Webtest_Spec
Used by: Webtest.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| Configuration | An XML configuration specification for a WebTest. | WebTestProperties_Configuration Optional |
| Description | User defined description for this WebTest. | string Optional |
| Enabled | Is the test actively being monitored. | bool Optional |
| Frequency | Interval in seconds between test runs for this WebTest. Default value is 300. | int Optional |
| Kind | The kind of web test this is, valid choices are ping, multistep and standard. | WebTestProperties_Kind Required |
| location | Resource location | string Required |
| Locations | A list of where to physically run the tests from to give global coverage for accessibility of your application. | WebTestGeolocation[] Required |
| Name | User defined name if this WebTest. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WebtestOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| Request | The collection of request properties | WebTestProperties_Request Optional |
| RetryEnabled | Allow for retries should this WebTest fail. | bool Optional |
| SyntheticMonitorId | Unique ID of this WebTest. This is typically the same value as the Name field. | string Required |
| tags | Resource tags | map[string]string Optional |
| Timeout | Seconds until this WebTest will timeout and fail. Default value is 30. | int Optional |
| ValidationRules | The collection of validation rule properties | WebTestProperties_ValidationRules Optional |
Webtest_STATUS
Used by: Webtest.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| Configuration | An XML configuration specification for a WebTest. | WebTestProperties_Configuration_STATUS Optional |
| Description | User defined description for this WebTest. | string Optional |
| Enabled | Is the test actively being monitored. | bool Optional |
| Frequency | Interval in seconds between test runs for this WebTest. Default value is 300. | int Optional |
| id | Azure resource Id | string Optional |
| Kind | The kind of web test this is, valid choices are ping, multistep and standard. | WebTestProperties_Kind_STATUS Optional |
| location | Resource location | string Optional |
| Locations | A list of where to physically run the tests from to give global coverage for accessibility of your application. | WebTestGeolocation_STATUS[] Optional |
| name | Azure resource name | string Optional |
| properties_name | User defined name if this WebTest. | string Optional |
| provisioningState | Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. | string Optional |
| Request | The collection of request properties | WebTestProperties_Request_STATUS Optional |
| RetryEnabled | Allow for retries should this WebTest fail. | bool Optional |
| SyntheticMonitorId | Unique ID of this WebTest. This is typically the same value as the Name field. | string Optional |
| tags | Resource tags | map[string]string Optional |
| Timeout | Seconds until this WebTest will timeout and fail. Default value is 30. | int Optional |
| type | Azure resource type | string Optional |
| ValidationRules | The collection of validation rule properties | WebTestProperties_ValidationRules_STATUS Optional |
Actions
Actions to invoke when the alert fires.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| actionGroupsReferences | Action Group resource Ids to invoke when the alert fires. | genruntime.ResourceReference[] Optional |
| customProperties | The properties of an alert payload. | map[string]string Optional |
Actions_STATUS
Actions to invoke when the alert fires.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| actionGroups | Action Group resource Ids to invoke when the alert fires. | string[] Optional |
| customProperties | The properties of an alert payload. | map[string]string Optional |
ScheduledQueryRule_Kind_Spec
Used by: ScheduledQueryRule_Spec.
| Value | Description |
|---|---|
| “LogAlert” | |
| “LogToMetric” |
ScheduledQueryRule_Kind_STATUS
Used by: ScheduledQueryRule_STATUS.
| Value | Description |
|---|---|
| “LogAlert” | |
| “LogToMetric” |
ScheduledQueryRuleCriteria
The rule criteria that defines the conditions of the scheduled query rule.
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| allOf | A list of conditions to evaluate against the specified scopes | Condition[] Optional |
ScheduledQueryRuleCriteria_STATUS
The rule criteria that defines the conditions of the scheduled query rule.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| allOf | A list of conditions to evaluate against the specified scopes | Condition_STATUS[] Optional |
ScheduledQueryRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ScheduledQueryRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ScheduledQueryRuleProperties_Severity
Used by: ScheduledQueryRule_Spec.
| Value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | |
| 3 | |
| 4 |
ScheduledQueryRuleProperties_Severity_STATUS
Used by: ScheduledQueryRule_STATUS.
| Value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | |
| 3 | |
| 4 |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: ScheduledQueryRule_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
WebTestGeolocation
Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.
Used by: Webtest_Spec.
| Property | Description | Type |
|---|---|---|
| Id | Location ID for the WebTest to run from. | string Optional |
WebTestGeolocation_STATUS
Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.
Used by: Webtest_STATUS.
| Property | Description | Type |
|---|---|---|
| Id | Location ID for the WebTest to run from. | string Optional |
WebtestOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Webtest_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
WebTestProperties_Configuration
Used by: Webtest_Spec.
| Property | Description | Type |
|---|---|---|
| WebTest | The XML specification of a WebTest to run against an application. | string Optional |
WebTestProperties_Configuration_STATUS
Used by: Webtest_STATUS.
| Property | Description | Type |
|---|---|---|
| WebTest | The XML specification of a WebTest to run against an application. | string Optional |
WebTestProperties_Kind
Used by: Webtest_Spec.
| Value | Description |
|---|---|
| “multistep” | |
| “ping” | |
| “standard” |
WebTestProperties_Kind_STATUS
Used by: Webtest_STATUS.
| Value | Description |
|---|---|
| “multistep” | |
| “ping” | |
| “standard” |
WebTestProperties_Request
Used by: Webtest_Spec.
| Property | Description | Type |
|---|---|---|
| FollowRedirects | Follow redirects for this web test. | bool Optional |
| Headers | List of headers and their values to add to the WebTest call. | HeaderField[] Optional |
| HttpVerb | Http verb to use for this web test. | string Optional |
| ParseDependentRequests | Parse Dependent request for this WebTest. | bool Optional |
| RequestBody | Base64 encoded string body to send with this web test. | string Optional |
| RequestUrl | Url location to test. | string Optional |
WebTestProperties_Request_STATUS
Used by: Webtest_STATUS.
| Property | Description | Type |
|---|---|---|
| FollowRedirects | Follow redirects for this web test. | bool Optional |
| Headers | List of headers and their values to add to the WebTest call. | HeaderField_STATUS[] Optional |
| HttpVerb | Http verb to use for this web test. | string Optional |
| ParseDependentRequests | Parse Dependent request for this WebTest. | bool Optional |
| RequestBody | Base64 encoded string body to send with this web test. | string Optional |
| RequestUrl | Url location to test. | string Optional |
WebTestProperties_ValidationRules
Used by: Webtest_Spec.
| Property | Description | Type |
|---|---|---|
| ContentValidation | The collection of content validation properties | WebTestProperties_ValidationRules_ContentValidation Optional |
| ExpectedHttpStatusCode | Validate that the WebTest returns the http status code provided. | int Optional |
| IgnoreHttpStatusCode | When set, validation will ignore the status code. | bool Optional |
| SSLCertRemainingLifetimeCheck | A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true. | int Optional |
| SSLCheck | Checks to see if the SSL cert is still valid. | bool Optional |
WebTestProperties_ValidationRules_STATUS
Used by: Webtest_STATUS.
| Property | Description | Type |
|---|---|---|
| ContentValidation | The collection of content validation properties | WebTestProperties_ValidationRules_ContentValidation_STATUS Optional |
| ExpectedHttpStatusCode | Validate that the WebTest returns the http status code provided. | int Optional |
| IgnoreHttpStatusCode | When set, validation will ignore the status code. | bool Optional |
| SSLCertRemainingLifetimeCheck | A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true. | int Optional |
| SSLCheck | Checks to see if the SSL cert is still valid. | bool Optional |
Condition
A condition of the scheduled query rule.
Used by: ScheduledQueryRuleCriteria.
| Property | Description | Type |
|---|---|---|
| dimensions | List of Dimensions conditions | Dimension[] Optional |
| 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. | Condition_FailingPeriods Optional |
| metricMeasureColumn | The column containing the metric measure number. Relevant only for rules of the kind LogAlert. | string Optional |
| metricName | The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. | string Optional |
| operator | The criteria operator. Relevant and required only for rules of the kind LogAlert. | Condition_Operator Optional |
| query | Log query alert | string Optional |
| resourceIdColumnReference | 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. | genruntime.ResourceReference Optional |
| threshold | the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. | float64 Optional |
| timeAggregation | Aggregation type. Relevant and required only for rules of the kind LogAlert. | Condition_TimeAggregation Optional |
Condition_STATUS
A condition of the scheduled query rule.
Used by: ScheduledQueryRuleCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| dimensions | List of Dimensions conditions | Dimension_STATUS[] Optional |
| 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. | Condition_FailingPeriods_STATUS Optional |
| metricMeasureColumn | The column containing the metric measure number. Relevant only for rules of the kind LogAlert. | string Optional |
| metricName | The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. | string Optional |
| operator | The criteria operator. Relevant and required only for rules of the kind LogAlert. | Condition_Operator_STATUS Optional |
| query | Log query alert | string Optional |
| 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. | string Optional |
| threshold | the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. | float64 Optional |
| timeAggregation | Aggregation type. Relevant and required only for rules of the kind LogAlert. | Condition_TimeAggregation_STATUS Optional |
HeaderField
A header to add to the WebTest.
Used by: WebTestProperties_Request.
| Property | Description | Type |
|---|---|---|
| key | The name of the header. | string Optional |
| value | The value of the header. | string Optional |
HeaderField_STATUS
A header to add to the WebTest.
Used by: WebTestProperties_Request_STATUS.
| Property | Description | Type |
|---|---|---|
| key | The name of the header. | string Optional |
| value | The value of the header. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
WebTestProperties_ValidationRules_ContentValidation
Used by: WebTestProperties_ValidationRules.
| Property | Description | Type |
|---|---|---|
| ContentMatch | Content to look for in the return of the WebTest. Must not be null or empty. | string Optional |
| IgnoreCase | When set, this value makes the ContentMatch validation case insensitive. | bool Optional |
| PassIfTextFound | When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match | bool Optional |
WebTestProperties_ValidationRules_ContentValidation_STATUS
Used by: WebTestProperties_ValidationRules_STATUS.
| Property | Description | Type |
|---|---|---|
| ContentMatch | Content to look for in the return of the WebTest. Must not be null or empty. | string Optional |
| IgnoreCase | When set, this value makes the ContentMatch validation case insensitive. | bool Optional |
| PassIfTextFound | When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match | bool Optional |
Condition_FailingPeriods
Used by: Condition.
| Property | Description | Type |
|---|---|---|
| minFailingPeriodsToAlert | The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 | int Optional |
| 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 | int Optional |
Condition_FailingPeriods_STATUS
Used by: Condition_STATUS.
| Property | Description | Type |
|---|---|---|
| minFailingPeriodsToAlert | The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 | int Optional |
| 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 | int Optional |
Condition_Operator
Used by: Condition.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” |
Condition_Operator_STATUS
Used by: Condition_STATUS.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” |
Condition_TimeAggregation
Used by: Condition.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
Condition_TimeAggregation_STATUS
Used by: Condition_STATUS.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
Dimension
Dimension splitting and filtering definition
Used by: Condition.
| Property | Description | Type |
|---|---|---|
| name | Name of the dimension | string Required |
| operator | Operator for dimension values | Dimension_Operator Required |
| values | List of dimension values | string[] Required |
Dimension_STATUS
Dimension splitting and filtering definition
Used by: Condition_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the dimension | string Optional |
| operator | Operator for dimension values | Dimension_Operator_STATUS Optional |
| values | List of dimension values | string[] Optional |
Dimension_Operator
Used by: Dimension.
| Value | Description |
|---|---|
| “Exclude” | |
| “Include” |
Dimension_Operator_STATUS
Used by: Dimension_STATUS.
| Value | Description |
|---|---|
| “Exclude” | |
| “Include” |