DATASOURCE::ARMS::GrafanaWorkspace - Resource Orchestration Service

DATASOURCE::ARMS::GrafanaWorkspace is used to query the information about a Grafana workspace.

Syntax

{
  "Type": "DATASOURCE::ARMS::GrafanaWorkspace",
  "Properties": {
    "GrafanaWorkspaceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

GrafanaWorkspaceId

String

Yes

The workspace 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

GrafanaVersion: the Grafana version.
Description: the description of the workspace.
ResourceGroupId: the ID of the resource group.
GrafanaWorkspaceId: the workspace ID.
CreateTime: the time when the workspace was created.
GrafanaWorkspaceEdition: the version of the workspace.
GrafanaWorkspaceName: the workspace name.
Tags: the tags that are added to the workspace.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GrafanaWorkspaceId:
    Type: String
    Description:
      en: The first ID of the resource.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::GrafanaWorkspace
    Properties:
      GrafanaWorkspaceId:
        Ref: GrafanaWorkspaceId
Outputs:
  GrafanaVersion:
    Description: The version number of Grafana.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaVersion
  Description:
    Description: The description of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The resource group ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  GrafanaWorkspaceId:
    Description: The ID of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaWorkspaceId
  CreateTime:
    Description: The time when the workspace was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  GrafanaWorkspaceEdition:
    Description: The version of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaWorkspaceEdition
  GrafanaWorkspaceName:
    Description: The workspace name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaWorkspaceName
  Tags:
    Description: The tags of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GrafanaWorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "The first ID of the resource."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::GrafanaWorkspace",
      "Properties": {
        "GrafanaWorkspaceId": {
          "Ref": "GrafanaWorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "GrafanaVersion": {
      "Description": "The version number of Grafana.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaVersion"
        ]
      }
    },
    "Description": {
      "Description": "The description of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The resource group ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "GrafanaWorkspaceId": {
      "Description": "The ID of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaWorkspaceId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the workspace was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "GrafanaWorkspaceEdition": {
      "Description": "The version of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaWorkspaceEdition"
        ]
      }
    },
    "GrafanaWorkspaceName": {
      "Description": "The workspace name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaWorkspaceName"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}