Supported Variables
Resource Scheduler supports all the general variables.
(See General Variables for All Requests), plus the variables listed in the following table:
Naming Conventions
Variables are lowercase and hyphen-separated.
target.tag-namespace.name #
"name"
indicates a unique key
target.display-name #
"display-name"
indicates a non-unique description
Variable Types and Sources
Type | Type Description |
---|---|
String | Free-form text |
List(Type) | List of Entity or String |
Entity | OCID |
Source | Source Description |
---|---|
Request | Comes from the request input |
Derived | Comes from the request |
Stored | Comes from the service, retained input |
Computed | Computed from service data |
Variables for Every Request
Required Variables
The following table shows required variables, which are supplied by the services for every request.
Variable | Variable type | Description |
---|---|---|
target.compartment.id |
ENTITY |
The OCID of the primary resource for the request |
request.operation |
STRING |
The operation ID, such as GetUser for the request |
target.resource.kind |
STRING |
The resource kind name of the primary resource for the request |
The following table shows automatic variables, which are supplied by the SDK for every request.
Automatic Variables
Variable | Variable type | Description |
---|---|---|
For user initiated requests: request.user.id
|
ENTITY
|
The OCID of the calling user The OCIDs of the groups of |
request.principal.group.tag.
|
STRING |
The value of each tag on a group of which the principal is a member |
request.principal.compartment.tag.
|
STRING |
The value of each tag in a compartment of which the principal is a member |
The following table shows dynamic variables, which are computed implicitly by IAM AuthZ.
Dynamic Variables
Variable | Variable type | Description |
---|---|---|
request.principal.group.tag.
|
STRING |
The value of each tag on a group of which the principal is a member. |
request.principal.compartment.tag.
|
STRING |
The value of each tag on the compartment that contains the principal. |
target.resource.tag.<tagNS>.
|
STRING |
The value of each tag on the target resource. (Computed based on tagSlug supplied by service on each request.) |
target.resource.compartment.tag.
|
STRING |
The value of each tag on the compartment that contains the target resource. |