PrometheusReporter
Global Operations
Resource path:
/global-config/services/monitoring/prometheus
Resource version: 1.0
create
Usage
am> create PrometheusReporter --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "passwordPurpose" : { "title" : "Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.monitoring.prometheus.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If this field is populated, the password defined above will be ignored for authentication purposes.", "propertyOrder" : 350, "required" : false, "type" : "string", "exampleValue" : "" }, "username" : { "title" : "Username", "description" : "", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "password" : { "title" : "Password", "description" : "", "propertyOrder" : 300, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "enabled" : { "title" : "Enabled", "description" : "", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "authenticationType" : { "title" : "Authentication Type", "description" : "", "propertyOrder" : 150, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete PrometheusReporter --global --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action PrometheusReporter --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PrometheusReporter --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action PrometheusReporter --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PrometheusReporter --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PrometheusReporter --global --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PrometheusReporter --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "passwordPurpose" : { "title" : "Secret Label Identifier", "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.monitoring.prometheus.{{identifier}}.secret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If this field is populated, the password defined above will be ignored for authentication purposes.", "propertyOrder" : 350, "required" : false, "type" : "string", "exampleValue" : "" }, "username" : { "title" : "Username", "description" : "", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "password" : { "title" : "Password", "description" : "", "propertyOrder" : 300, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "enabled" : { "title" : "Enabled", "description" : "", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "authenticationType" : { "title" : "Authentication Type", "description" : "", "propertyOrder" : 150, "required" : true, "type" : "string", "exampleValue" : "" } } }