All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ARMS::PrometheusAuthToken

更新時間:Nov 01, 2024

DATASOURCE::ARMS::PrometheusAuthToken is used to query an authentication token for read and write over the Internet.

Syntax

{
  "Type": "DATASOURCE::ARMS::PrometheusAuthToken",
  "Properties": {
    "ClusterId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ClusterId

String

No

Yes

The ID of the Container Service for Kubernetes (ACK) cluster.

None.

RefreshOptions

String

No

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

Token: the information about the token.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Description:
      en: Cluster ID.
    Required: false
    Type: String
Resources:
  PrometheusAuthToken:
    Properties:
      ClusterId:
        Ref: ClusterId
    Type: DATASOURCE::ARMS::PrometheusAuthToken
Outputs:
  Token:
    Description: The token for Grafana read URL.
    Value:
      Fn::GetAtt:
      - PrometheusAuthToken
      - Token
                        

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": {
        "en": "Cluster ID."
      },
      "Required": false
    }
  },
  "Resources": {
    "PrometheusAuthToken": {
      "Type": "DATASOURCE::ARMS::PrometheusAuthToken",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "Token": {
      "Description": "The token for Grafana read URL.",
      "Value": {
        "Fn::GetAtt": [
          "PrometheusAuthToken",
          "Token"
        ]
      }
    }
  }
}