DATASOURCE::ARMS::Environment - Resource Orchestration Service

The DATASOURCE::ARMS::Environment type queries the details of a single environment.

Syntax

{
  "Type": "DATASOURCE::ARMS::Environment",
  "Properties": {
    "EnvironmentId": String,
    "RefreshOptions": String
  }
}

Properties

Parameter

Type

Required

Update allowed

Description

Constraints

EnvironmentId

String

Yes

The environment instance ID.

None

RefreshOptions

String

Yes

The refresh policy for the datasource during stack updates.

Valid values:

Never (default): The datasource is not refreshed during stack updates.
Always: The datasource is always refreshed during stack updates.

Attributes

Fn::GetAtt

ManagedType: The managed type.
ResourceGroupId: The resource group ID.
GrafanaDatasourceUid: The UID of the Grafana datasource.
EnvironmentName: The name of the environment.
FeePackage: The fee package.
GrafanaFolderUid: The UID of the associated Grafana folder.
EnvironmentSubType: The subtype of the environment.
EnvironmentId: The environment instance ID.
BindResourceType: The type of the associated resource.
EnvironmentType: The type of the environment.
BindResourceId: The ID of the associated container instance or VPC.
UserId: The user ID.
PrometheusInstanceId: The Prometheus instance ID.
BindVpcCidr: The CIDR block of the associated VPC.
Tags: The tags of the environment.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  EnvironmentId:
    Type: String
    Description:
      en: The environment instance ID.
    Required: true
  RefreshOptions:
    Type: String
    Description:
      en: |-
        The refresh policy for the datasource during stack updates. Valid values:
        - Never: The datasource is not refreshed during stack updates.
        - Always: The datasource is always refreshed during stack updates.
        Default: Never.
    AllowedValues:
      - Always
      - Never
    Default: Never
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::Environment
    Properties:
      EnvironmentId:
        Ref: EnvironmentId
      RefreshOptions:
        Ref: RefreshOptions
Outputs:
  ManagedType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ManagedType
    Description: The managed type.
  EnvironmentName:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentName
    Description: The name of the environment.
  BindVpcCidr:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BindVpcCidr
    Description: The CIDR block of the associated VPC.
  EnvironmentSubType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentSubType
    Description: The subtype of the environment.
  FeePackage:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - FeePackage
    Description: The fee package.
  Tags:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
    Description: The tags of the environment.
  UserId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UserId
    Description: The user ID.
  PrometheusInstanceId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PrometheusInstanceId
    Description: The Prometheus instance ID.
  EnvironmentId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentId
    Description: The environment instance ID.
  ResourceGroupId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
    Description: The resource group ID.
  GrafanaFolderUid:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaFolderUid
    Description: The UID of the associated Grafana folder.
  BindResourceId:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BindResourceId
    Description: The ID of the associated container instance or VPC.
  BindResourceType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BindResourceType
    Description: The type of the associated resource.
  GrafanaDatasourceUid:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GrafanaDatasourceUid
    Description: The UID of the Grafana datasource.
  EnvironmentType:
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentType
    Description: The type of the environment.

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EnvironmentId": {
      "Type": "String",
      "Description": {
        "en": "The environment instance ID."
      },
      "Required": true
    },
    "RefreshOptions": {
      "Type": "String",
      "Description": {
        "en": "The refresh policy for the datasource during stack updates. Valid values:\n- Never: The datasource is not refreshed during stack updates.\n- Always: The datasource is always refreshed during stack updates.\nDefault: Never."
      },
      "AllowedValues": [
        "Always",
        "Never"
      ],
      "Default": "Never",
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::Environment",
      "Properties": {
        "EnvironmentId": {
          "Ref": "EnvironmentId"
        },
        "RefreshOptions": {
          "Ref": "RefreshOptions"
        }
      }
    }
  },
  "Outputs": {
    "ManagedType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ManagedType"
        ]
      },
      "Description": "The managed type."
    },
    "EnvironmentName": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentName"
        ]
      },
      "Description": "The name of the environment."
    },
    "BindVpcCidr": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BindVpcCidr"
        ]
      },
      "Description": "The CIDR block of the associated VPC."
    },
    "EnvironmentSubType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentSubType"
        ]
      },
      "Description": "The subtype of the environment."
    },
    "FeePackage": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "FeePackage"
        ]
      },
      "Description": "The fee package."
    },
    "Tags": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      },
      "Description": "The tags of the environment."
    },
    "UserId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UserId"
        ]
      },
      "Description": "The user ID."
    },
    "PrometheusInstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrometheusInstanceId"
        ]
      },
      "Description": "The Prometheus instance ID."
    },
    "EnvironmentId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentId"
        ]
      },
      "Description": "The environment instance ID."
    },
    "ResourceGroupId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      },
      "Description": "The resource group ID."
    },
    "GrafanaFolderUid": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaFolderUid"
        ]
      },
      "Description": "The UID of the associated Grafana folder."
    },
    "BindResourceId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BindResourceId"
        ]
      },
      "Description": "The ID of the associated container instance or VPC."
    },
    "BindResourceType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BindResourceType"
        ]
      },
      "Description": "The type of the associated resource."
    },
    "GrafanaDatasourceUid": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GrafanaDatasourceUid"
        ]
      },
      "Description": "The UID of the Grafana datasource."
    },
    "EnvironmentType": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentType"
        ]
      },
      "Description": "The type of the environment."
    }
  }
}