DATASOURCE::ARMS::SyntheticTask - Resource Orchestration Service

DATASOURCE::ARMS::SyntheticTask is used to query the information about a scheduled synthetic monitoring task.

Syntax

{
  "Type": "DATASOURCE::ARMS::SyntheticTask",
  "Properties": {
    "TaskId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

TaskId

String

Yes

The task ID.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

TaskId: the task ID.
ResourceGroupId: the ID of the resource group.
CustomPeriod: the custom cycle.
MonitorConf: the configurations of the task.
AvailableAssertions: the assertions.
TaskType: the task type.
Monitors: the detection points.
Frequency: the interval at which synthetic monitoring is performed.
MonitorCategory: the type of the detection point.
SyntheticTaskName: the task name.
Tags: the tags that are added to the task.
CommonSetting: the general settings.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TaskId:
    Type: String
    Description:
      en: The ID of the synthetic monitoring task.
    Required: true
  RefreshOptions:
    Type: String
    Description:
      en: |-
        The refresh strategy for the datasource resource when the stack is updated. Valid values:
        - Never: Never refresh the datasource resource when the stack is updated.
        - Always: Always refresh the datasource resource when the stack is updated.
        Default is Never.
    AllowedValues:
      - Always
      - Never
    Required: false
    Default: Never
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::SyntheticTask
    Properties:
      TaskId:
        Ref: TaskId
      RefreshOptions:
        Ref: RefreshOptions
Outputs:
  TaskId:
    Description: The ID of the synthetic monitoring task.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TaskId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CustomPeriod:
    Description: The custom cycle.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CustomPeriod
  MonitorConf:
    Description: The monitoring configurations.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MonitorConf
  AvailableAssertions:
    Description: The list of assertions.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AvailableAssertions
  TaskType:
    Description: The type of the task.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TaskType
  Monitors:
    Description: The list of monitoring points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Monitors
  Frequency:
    Description: 'The detection frequency. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Frequency
  MonitorCategory:
    Description: 'The detection point type. 1: PC. 2: mobile device.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MonitorCategory
  SyntheticTaskName:
    Description: The name of synthetic task.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SyntheticTaskName
  Tags:
    Description: The tags of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  CommonSetting:
    Description: The general settings.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonSetting

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TaskId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the synthetic monitoring task."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::SyntheticTask",
      "Properties": {
        "TaskId": {
          "Ref": "TaskId"
        }
      }
    }
  },
  "Outputs": {
    "TaskId": {
      "Description": "The ID of the synthetic monitoring task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TaskId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CustomPeriod": {
      "Description": "The custom cycle.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomPeriod"
        ]
      }
    },
    "MonitorConf": {
      "Description": "The monitoring configurations.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MonitorConf"
        ]
      }
    },
    "AvailableAssertions": {
      "Description": "The list of assertions.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AvailableAssertions"
        ]
      }
    },
    "TaskType": {
      "Description": "The type of the task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TaskType"
        ]
      }
    },
    "Monitors": {
      "Description": "The list of monitoring points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Monitors"
        ]
      }
    },
    "Frequency": {
      "Description": "The detection frequency. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Frequency"
        ]
      }
    },
    "MonitorCategory": {
      "Description": "The detection point type. 1: PC. 2: mobile device.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MonitorCategory"
        ]
      }
    },
    "SyntheticTaskName": {
      "Description": "The name of synthetic task.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SyntheticTaskName"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "CommonSetting": {
      "Description": "The general settings.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonSetting"
        ]
      }
    }
  }
}