DATASOURCE::ARMS::Prometheis - Resource Orchestration Service

DATASOURCE::ARMS::Prometheis is used to query Prometheus instances.

Syntax

{
  "Type": "DATASOURCE::ARMS::Prometheis",
  "Properties": {
    "ResourceGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ResourceGroupId

String

Yes

The ID of the resource group.

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

Prometheis: details of the Prometheus instances.
ClusterIds: the IDs of the Prometheus instances.

Property	Type	Description	Constraint
ClusterIds	List	The IDs of the Prometheus instances.	None.
Prometheis	List	Details of the Prometheus instances.	None.
RegionId	String	The region ID.	None.
PaymentType	String	The billing method.	None.
PrometheusName	String	The name of the Prometheus instance.	None.
UserId	String	The user ID.	None.
ClusterId	String	The ID of the Prometheus instance.	None.
ClusterType	String	The Prometheus instance type.	None.
ResourceGroupId	String	The ID of the resource group to which the Prometheus instance belongs.	None.
Tags	List	The tags.	None.
VSwitchId	String	The vSwitch ID.	None.
GrafanaInstanceId	String	The ID of the Grafana workspace.	None.
SecurityGroupId	String	The ID of the security group.	None.
SubClustersJson	String	The child instances of the Prometheus instance for GlobalView. The value is a JSON string.	None.
VpcId	String	The ID of the virtual private cloud (VPC).	None.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Description:
      en: The ID of the resource group.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
    Type: DATASOURCE::ARMS::Prometheis
Outputs:
  ClusterIds:
    Description: The list of cluster IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ClusterIds
  Prometheis:
    Description: The list of Prometheus.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Prometheis

`JSON` format

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the resource group."
      }
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::Prometheis",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        }
      }
    }
  },
  "Outputs": {
    "Prometheis": {
      "Description": "The list of Prometheis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Prometheis"
        ]
      }
    },
    "ClusterIds": {
      "Description": "The list of cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClusterIds"
        ]
      }
    }
  }
}