show\_resource\_groups(names=None, options={"{"}{"}"})\[source]

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

Parameters

names (list of str) –

List of names of groups to be shown. A single entry with an empty string returns all groups. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

show\_default\_values – If true include values of fields that are based on the default resource group. Allowed values are:
- true
- false
The default value is ‘true’.
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. Allowed values are:
- true
- false
The default value is ‘true’.
show\_tier\_usage – If true include the resource group usage on the worker ranks in the response. Allowed values are:
- true
- false
The default value is ‘false’.

The default value is an empty dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

groups (list of dicts of str to str) –

Map of resource group information.

rank\_usage (dict of str to str) –

Tier usage across ranks. Layout is: response.rank\_usage\[rank\_number]\[resource\_group\_name] = group\_usage (as stringified JSON).

info (dict of str to str) –

Additional information.