DATASOURCE::ARMS::XTraceApp - Resource Orchestration Service

DATASOURCE::ARMS::XTraceApp is used to query the information about an application monitoring task.

Syntax

{
  "Type": "DATASOURCE::ARMS::XTraceApp",
  "Properties": {
    "Pid": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Pid

String

Yes

The ID of the application.

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

ResourceGroupId: the ID of the resource group.
CreateTime: the timestamp when the task was created.
Pid: the ID of the application.
Tags: the tags of the application.
XTraceAppName: the name of the application.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Pid:
    Type: String
    Description:
      en: The process identifier (PID) of the application.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::XTraceApp
    Properties:
      Pid:
        Ref: Pid
Outputs:
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CreateTime:
    Description: The timestamp generated when the task was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Pid:
    Description: The process identifier (PID) of the application.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Pid
  Tags:
    Description: The tags of the application.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  XTraceAppName:
    Description: The name of the application.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - XTraceAppName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Pid": {
      "Type": "String",
      "Description": {
        "en": "The process identifier (PID) of the application."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::XTraceApp",
      "Properties": {
        "Pid": {
          "Ref": "Pid"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The timestamp generated when the task was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Pid": {
      "Description": "The process identifier (PID) of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Pid"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "XTraceAppName": {
      "Description": "The name of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "XTraceAppName"
        ]
      }
    }
  }
}