DATASOURCE::ARMS::GrafanaWorkspaces - Resource Orchestration Service

DATASOURCE::ARMS::GrafanaWorkspaces is used to query the information about Grafana workspaces.

Syntax

{
  "Type": "DATASOURCE::ARMS::GrafanaWorkspaces",
  "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

GrafanaWorkspaceIds: the IDs of the workspaces.
GrafanaWorkspaces: details of the workspaces.

Property	Type	Description	Constraint
GrafanaWorkspaceIds	List	The IDs of the workspaces.	None.
GrafanaWorkspaces	List	Details of the workspaces.	None.
ResourceGroupId	String	The ID of the resource group.	None.
GrafanaWorkspaceId	String	The workspace ID.	None.
Tags	Map	The tags of the workspace.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
    Type: String
    Description:
      en: The ID of the resource group to which the Prometheus instance belongs.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::GrafanaWorkspaces
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
Outputs:
  GrafanaWorkspaceIds:
    Description: The list of grafana workspace IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaWorkspaceIds
  GrafanaWorkspaces:
    Description: The list of grafana workspaces.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaWorkspaces

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Type": "String",
      "Description": {
        "en": "The ID of the resource group to which the Prometheus instance belongs."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::GrafanaWorkspaces",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        }
      }
    }
  },
  "Outputs": {
    "GrafanaWorkspaceIds": {
      "Description": "The list of grafana workspace IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaWorkspaceIds"
        ]
      }
    },
    "GrafanaWorkspaces": {
      "Description": "The list of grafana workspaces.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaWorkspaces"
        ]
      }
    }
  }
}