Supported Variables
Learn about the supported variables for Batch.
Batch service supports all the general variables. For more information, see General Variables for All Requests.
You can use variables to add conditions to a policy.
- Entity: Oracle Cloud Identifier (OCID).
- String: Free-form text.
- List: List of Entity or String.
Variables are lowercase and hyphen-separated. For example, target.tag-namespace.name, target.display-name.
Required variables are supplied by the Batch service for every request. Automatic variables are supplied by the authorization engine (either service-local with the SDK for a thick client, or on the Identity data plane for a thin client).
| Required Variables | Type | Description |
|---|---|---|
target.compartment.id |
ENTITY
|
The OCID of the primary resource for the request. |
request.operation |
STRING |
The operation ID (for example, GetUser) for the request. |
target.resource.kind |
STRING |
The resource kind name of the primary resource for the request. |
Following is a list of sources for Batch variables:
- Request: Comes from the request input.
- Derived: Comes from the request.
- Stored: Comes from the service, retained input.
- Computed: Computed from service data.
The following table summarizes the list of variables supplied by SDK for every request.
| Resource Type | Variable Name | Type | Source | Description |
|---|---|---|---|---|
| batch-computing-context | target.batch-context.id |
ENTITY |
Request | The OCID of the batch context. |
| batch-computing-context | target.batch-context.display-name |
ENTITY |
Request | Display name of the batch context. |
| batch-computing-job-pool | target.batch-job-pool.id |
ENTITY |
Stored | The OCID of the batch job pool. |
| batch-computing-job-pool | target.batch-job-pool.display-name |
ENTITY |
Request | Display name of the batch job pool. |
| batch-computing-job-pool | target.batch-context.id |
ENTITY |
Stored | The OCID of the batch context to which the job pool belongs. |
| batch-computing-job-pool | target.batch-context.display-name |
Entity | Stored | Display name of the batch context to which the job pool belongs. |
| batch-computing-job | target.batch-job.id |
Entity | Request | The OCID of the batch job. |
| batch-computing-job | target.batch-job.display-name |
Entity | Request | Display name of the batch job. |
| batch-computing-job | target.batch-job-pool.id |
Entity | Stored | The OCID of the batch job pool to which the job belongs. |
| batch-computing-job | target.batch-job-pool.display-name |
Entity | Stored | Display name of the batch job pool to which the job belongs. |
| batch-computing-task-profile | target.batch-task-profile.id |
Entity | Request | The OCID of the batch task profile. |
| batch-computing-task-profile | target.batch-task-profile.display-name |
Entity | Request | Display name of the batch task profile. |
| batch-computing-task-environment | target.batch-task-environment.id |
Entity | Request | The OCID of the batch task environment. |
| batch-computing-task-environment | target.batch-task-environment.display-name |
Entity | Request | Display name of the batch task environment. |
The following table summarizes the dynamic variables used in Batch
| Dynamic Variables | Type | Description |
|---|---|---|
request.principal.group.tag.<tagNS>.<tagKey> |
STRING |
The value of each tag on a group of which the principal is a member. |
request.principal.compartment.tag.<tagNS>.<tagKey> |
STRING |
The value of each tag on the compartment that contains the principal. |
target.resource.tag.<tagNS>.<tagKey> |
STRING |
The value of each tag on the target resource. |
target.resource.compartment.tag.<tagNS>.<tagKey> |
STRING |
The value of each tag on the compartment that contains the target resource. |