Show Resource Group

Requests resource group properties. Returns detailed information about the requested resource groups.

Input Parameter Description

NameTypeDescription
namesarray of stringsList of names of groups to be shown. A single entry with an empty string returns all groups.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
show_default_values

If true include values of fields that are based on the default resource group. The default value is true. The supported values are:

  • true
  • false
show_default_group

If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. The default value is true. The supported values are:

  • true
  • false
show_tier_usage

If true include the resource group usage on the worker ranks in the response. The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
groupsarray of maps of string to stringsMap of resource group information.
rank_usagemap of string to stringsTier usage across ranks. Layout is: response.rank_usage[rank_number][resource_group_name] = group_usage (as stringified json)
infomap of string to stringsAdditional information.