DATASOURCE::ARMS::SyntheticTasks is used to query scheduled synthetic monitoring tasks.
Syntax
{
"Type": "DATASOURCE::ARMS::SyntheticTasks",
"Properties": {
"ResourceGroupId": String,
"RefreshOptions": String
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
TaskIds: the IDs of the tasks.
SyntheticTasks: details of the tasks.
Property | Type | Description | Constraint |
TaskIds | List | The IDs of the tasks. | None. |
SyntheticTasks | List | Details of the tasks. | None. |
MonitorCategory | String | The type of the detection point. | None. |
Tags | Map | The tags that are added to the task. | None. |
SyntheticTaskName | String | The task name. | None. |
ResourceGroupId | String | The ID of the resource group. | None. |
Frequency | String | The frequency at which synthetic monitoring is performed. | None. |
TaskId | String | The task ID. | None. |
TaskType | String | The task type. | None. |
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
ResourceGroupId:
AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
Type: String
Description:
en: The ID of the resource group.
Required: false
Resources:
ExtensionDataSource:
Type: DATASOURCE::ARMS::SyntheticTasks
Properties:
ResourceGroupId:
Ref: ResourceGroupId
Outputs:
TaskIds:
Description: The list of task IDs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- TaskIds
SyntheticTasks:
Description: The list of synthetic tasks.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SyntheticTasks
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ResourceGroupId": {
"AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
"Type": "String",
"Description": {
"en": "The ID of the resource group."
},
"Required": false
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::ARMS::SyntheticTasks",
"Properties": {
"ResourceGroupId": {
"Ref": "ResourceGroupId"
}
}
}
},
"Outputs": {
"TaskIds": {
"Description": "The list of task IDs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"TaskIds"
]
}
},
"SyntheticTasks": {
"Description": "The list of synthetic tasks.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SyntheticTasks"
]
}
}
}
}