slis
Creates, updates, deletes, gets or lists a slis resource.
Overview
| Name | slis |
| Type | Resource |
| Id | azure.monitor_slis.slis |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_parent
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
baselineProperties | object | Defines the SLO baseline associated with the SLI. Required. |
category | string | Specifies the category of the SLI, used to classify signals such as Availability and Latency. Required. Known values are: "Availability" and "Latency". (Availability, Latency) |
description | string | A user-provided description of the SLI, with a maximum length of 1000 characters. Required. |
destinationAmwAccounts | array | Destination AMW accounts. Required. |
destinationMetrics | array | The destination Azure Monitor Workspace (AMW) accounts where the SLI emits metrics. |
enableAlert | boolean | A flag to determine whether alert is enabled. Required. |
evaluationType | string | Determines how the SLI is evaluated—either based on request counts or time windows. Required. Known values are: "WindowBased" and "RequestBased". (WindowBased, RequestBased) |
executionState | object | Indicates the current execution status of the SLI resource in ARM responses. |
identity | object | The managed service identities assigned to this resource. |
provisioningState | string | Indicates the provisioning status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
sliProperties | object | Defines the SLI properties associated with the SLI. Required. |
streamingRuleId | string | The streaming rule Id associated with the Sli resource. |
streamingRuleLastUpdatedTimestamp | string (date-time) | The streaming rule last updated timestamp associated with the Sli resource. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
baselineProperties | object | Defines the SLO baseline associated with the SLI. Required. |
category | string | Specifies the category of the SLI, used to classify signals such as Availability and Latency. Required. Known values are: "Availability" and "Latency". (Availability, Latency) |
description | string | A user-provided description of the SLI, with a maximum length of 1000 characters. Required. |
destinationAmwAccounts | array | Destination AMW accounts. Required. |
destinationMetrics | array | The destination Azure Monitor Workspace (AMW) accounts where the SLI emits metrics. |
enableAlert | boolean | A flag to determine whether alert is enabled. Required. |
evaluationType | string | Determines how the SLI is evaluated—either based on request counts or time windows. Required. Known values are: "WindowBased" and "RequestBased". (WindowBased, RequestBased) |
executionState | object | Indicates the current execution status of the SLI resource in ARM responses. |
identity | object | The managed service identities assigned to this resource. |
provisioningState | string | Indicates the provisioning status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
sliProperties | object | Defines the SLI properties associated with the SLI. Required. |
streamingRuleId | string | The streaming rule Id associated with the Sli resource. |
streamingRuleLastUpdatedTimestamp | string (date-time) | The streaming rule last updated timestamp associated with the Sli resource. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_group_name, sli_name | Gets an SLI resource. | |
list_by_parent | select | service_group_name | Lists all SLI resources under a parent resource. | |
create_or_update | insert | service_group_name, sli_name | Creates or updates an SLI resource. | |
create_or_update | replace | service_group_name, sli_name | Creates or updates an SLI resource. | |
delete | delete | service_group_name, sli_name | Deletes an SLI resource. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
service_group_name | string | The name of the service group. Required. |
sli_name | string | Name of the SLI that is given by the user. Required. |
SELECT examples
- get
- list_by_parent
Gets an SLI resource.
SELECT
id,
name,
baselineProperties,
category,
description,
destinationAmwAccounts,
destinationMetrics,
enableAlert,
evaluationType,
executionState,
identity,
provisioningState,
sliProperties,
streamingRuleId,
streamingRuleLastUpdatedTimestamp,
systemData,
type
FROM azure.monitor_slis.slis
WHERE service_group_name = '{{ service_group_name }}' -- required
AND sli_name = '{{ sli_name }}' -- required
;
Lists all SLI resources under a parent resource.
SELECT
id,
name,
baselineProperties,
category,
description,
destinationAmwAccounts,
destinationMetrics,
enableAlert,
evaluationType,
executionState,
identity,
provisioningState,
sliProperties,
streamingRuleId,
streamingRuleLastUpdatedTimestamp,
systemData,
type
FROM azure.monitor_slis.slis
WHERE service_group_name = '{{ service_group_name }}' -- required
;
INSERT examples
- create_or_update
- Manifest
Creates or updates an SLI resource.
INSERT INTO azure.monitor_slis.slis (
properties,
identity,
service_group_name,
sli_name
)
SELECT
'{{ properties }}',
'{{ identity }}',
'{{ service_group_name }}',
'{{ sli_name }}'
RETURNING
id,
name,
identity,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: slis
props:
- name: service_group_name
value: "{{ service_group_name }}"
description: Required parameter for the slis resource.
- name: sli_name
value: "{{ sli_name }}"
description: Required parameter for the slis resource.
- name: properties
description: |
The resource-specific properties for this resource.
value:
provisioningState: "{{ provisioningState }}"
description: "{{ description }}"
category: "{{ category }}"
evaluationType: "{{ evaluationType }}"
executionState:
state: "{{ state }}"
message: "{{ message }}"
destinationAmwAccounts:
- resourceId: "{{ resourceId }}"
identity: "{{ identity }}"
destinationMetrics:
- metricNamespace: "{{ metricNamespace }}"
metricName: "{{ metricName }}"
baselineProperties:
baseline:
value: {{ value }}
evaluationPeriodDays: {{ evaluationPeriodDays }}
evaluationCalculationType: "{{ evaluationCalculationType }}"
streamingRuleId: "{{ streamingRuleId }}"
streamingRuleLastUpdatedTimestamp: "{{ streamingRuleLastUpdatedTimestamp }}"
enableAlert: {{ enableAlert }}
sliProperties:
goodSignals:
signalSources:
- signalSourceId: "{{ signalSourceId }}"
sourceAmwAccountManagedIdentity: "{{ sourceAmwAccountManagedIdentity }}"
sourceAmwAccountResourceId: "{{ sourceAmwAccountResourceId }}"
metricNamespace: "{{ metricNamespace }}"
metricName: "{{ metricName }}"
filters: "{{ filters }}"
spatialAggregation:
type: "{{ type }}"
dimensions: "{{ dimensions }}"
temporalAggregation:
type: "{{ type }}"
windowSizeMinutes: {{ windowSizeMinutes }}
signalFormula: "{{ signalFormula }}"
totalSignals:
signalSources:
- signalSourceId: "{{ signalSourceId }}"
sourceAmwAccountManagedIdentity: "{{ sourceAmwAccountManagedIdentity }}"
sourceAmwAccountResourceId: "{{ sourceAmwAccountResourceId }}"
metricNamespace: "{{ metricNamespace }}"
metricName: "{{ metricName }}"
filters: "{{ filters }}"
spatialAggregation:
type: "{{ type }}"
dimensions: "{{ dimensions }}"
temporalAggregation:
type: "{{ type }}"
windowSizeMinutes: {{ windowSizeMinutes }}
signalFormula: "{{ signalFormula }}"
signals:
signalSources:
- signalSourceId: "{{ signalSourceId }}"
sourceAmwAccountManagedIdentity: "{{ sourceAmwAccountManagedIdentity }}"
sourceAmwAccountResourceId: "{{ sourceAmwAccountResourceId }}"
metricNamespace: "{{ metricNamespace }}"
metricName: "{{ metricName }}"
filters: "{{ filters }}"
spatialAggregation:
type: "{{ type }}"
dimensions: "{{ dimensions }}"
temporalAggregation:
type: "{{ type }}"
windowSizeMinutes: {{ windowSizeMinutes }}
signalFormula: "{{ signalFormula }}"
windowUptimeCriteria:
target: {{ target }}
comparator: "{{ comparator }}"
- name: identity
description: |
The managed service identities assigned to this resource.
value:
principalId: "{{ principalId }}"
tenantId: "{{ tenantId }}"
type: "{{ type }}"
userAssignedIdentities: "{{ userAssignedIdentities }}"
REPLACE examples
- create_or_update
Creates or updates an SLI resource.
REPLACE azure.monitor_slis.slis
SET
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE
service_group_name = '{{ service_group_name }}' --required
AND sli_name = '{{ sli_name }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;
DELETE examples
- delete
Deletes an SLI resource.
DELETE FROM azure.monitor_slis.slis
WHERE service_group_name = '{{ service_group_name }}' --required
AND sli_name = '{{ sli_name }}' --required
;