oci.oci.getBatchBatchJobPools

Oracle Cloud Infrastructure v3.16.0, Jan 28 26

Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Lists the batch job pools by compartment or job pool OCID. You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testBatchJobPools = oci.oci.getBatchBatchJobPools({
    batchContextId: testBatchContext.id,
    compartmentId: compartmentId,
    displayName: batchJobPoolDisplayName,
    id: batchJobPoolId,
    state: batchJobPoolState,
});

import pulumi
import pulumi_oci as oci

test_batch_job_pools = oci.oci.get_batch_batch_job_pools(batch_context_id=test_batch_context["id"],
    compartment_id=compartment_id,
    display_name=batch_job_pool_display_name,
    id=batch_job_pool_id,
    state=batch_job_pool_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.GetBatchBatchJobPools(ctx, &oci.GetBatchBatchJobPoolsArgs{
			BatchContextId: pulumi.StringRef(testBatchContext.Id),
			CompartmentId:  pulumi.StringRef(compartmentId),
			DisplayName:    pulumi.StringRef(batchJobPoolDisplayName),
			Id:             pulumi.StringRef(batchJobPoolId),
			State:          pulumi.StringRef(batchJobPoolState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBatchJobPools = Oci.Oci.GetBatchBatchJobPools.Invoke(new()
    {
        BatchContextId = testBatchContext.Id,
        CompartmentId = compartmentId,
        DisplayName = batchJobPoolDisplayName,
        Id = batchJobPoolId,
        State = batchJobPoolState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.OciFunctions;
import com.pulumi.oci.oci.inputs.GetBatchBatchJobPoolsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testBatchJobPools = OciFunctions.getBatchBatchJobPools(GetBatchBatchJobPoolsArgs.builder()
            .batchContextId(testBatchContext.id())
            .compartmentId(compartmentId)
            .displayName(batchJobPoolDisplayName)
            .id(batchJobPoolId)
            .state(batchJobPoolState)
            .build());

    }
}

variables:
  testBatchJobPools:
    fn::invoke:
      function: oci:oci:getBatchBatchJobPools
      arguments:
        batchContextId: ${testBatchContext.id}
        compartmentId: ${compartmentId}
        displayName: ${batchJobPoolDisplayName}
        id: ${batchJobPoolId}
        state: ${batchJobPoolState}

Using getBatchBatchJobPools

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBatchBatchJobPools(args: GetBatchBatchJobPoolsArgs, opts?: InvokeOptions): Promise<GetBatchBatchJobPoolsResult>
function getBatchBatchJobPoolsOutput(args: GetBatchBatchJobPoolsOutputArgs, opts?: InvokeOptions): Output<GetBatchBatchJobPoolsResult>

def get_batch_batch_job_pools(batch_context_id: Optional[str] = None,
                              compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              filters: Optional[Sequence[GetBatchBatchJobPoolsFilter]] = None,
                              id: Optional[str] = None,
                              state: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBatchBatchJobPoolsResult
def get_batch_batch_job_pools_output(batch_context_id: Optional[pulumi.Input[str]] = None,
                              compartment_id: Optional[pulumi.Input[str]] = None,
                              display_name: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBatchBatchJobPoolsFilterArgs]]]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBatchBatchJobPoolsResult]

func GetBatchBatchJobPools(ctx *Context, args *GetBatchBatchJobPoolsArgs, opts ...InvokeOption) (*GetBatchBatchJobPoolsResult, error)
func GetBatchBatchJobPoolsOutput(ctx *Context, args *GetBatchBatchJobPoolsOutputArgs, opts ...InvokeOption) GetBatchBatchJobPoolsResultOutput

> Note: This function is named GetBatchBatchJobPools in the Go SDK.

public static class GetBatchBatchJobPools 
{
    public static Task<GetBatchBatchJobPoolsResult> InvokeAsync(GetBatchBatchJobPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetBatchBatchJobPoolsResult> Invoke(GetBatchBatchJobPoolsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBatchBatchJobPoolsResult> getBatchBatchJobPools(GetBatchBatchJobPoolsArgs args, InvokeOptions options)
public static Output<GetBatchBatchJobPoolsResult> getBatchBatchJobPools(GetBatchBatchJobPoolsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:oci/getBatchBatchJobPools:getBatchBatchJobPools
  arguments:
    # arguments dictionary

The following arguments are supported:

BatchContextId string: The OCID of the batch context.
CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetBatchBatchJobPoolsFilter>
Id string: The OCID of the batch job pool.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

BatchContextId string: The OCID of the batch context.
CompartmentId string: The OCID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetBatchBatchJobPoolsFilter
Id string: The OCID of the batch job pool.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

batchContextId String: The OCID of the batch context.
compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetBatchBatchJobPoolsFilter>
id String: The OCID of the batch job pool.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

batchContextId string: The OCID of the batch context.
compartmentId string: The OCID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetBatchBatchJobPoolsFilter[]
id string: The OCID of the batch job pool.
state string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

batch_context_id str: The OCID of the batch context.
compartment_id str: The OCID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[GetBatchBatchJobPoolsFilter]
id str: The OCID of the batch job pool.
state str: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

batchContextId String: The OCID of the batch context.
compartmentId String: The OCID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
id String: The OCID of the batch job pool.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

getBatchBatchJobPools Result

The following output properties are available:

BatchJobPoolCollections List<GetBatchBatchJobPoolsBatchJobPoolCollection>: The list of batch_job_pool_collection.
BatchContextId string: The OCID of batch context.
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters List<GetBatchBatchJobPoolsFilter>
Id string: The OCID of the batch job pool.
State string: The current state of the batch job pool.

BatchJobPoolCollections []GetBatchBatchJobPoolsBatchJobPoolCollection: The list of batch_job_pool_collection.
BatchContextId string: The OCID of batch context.
CompartmentId string: The OCID of the compartment.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
Filters []GetBatchBatchJobPoolsFilter
Id string: The OCID of the batch job pool.
State string: The current state of the batch job pool.

batchJobPoolCollections List<GetBatchBatchJobPoolsBatchJobPoolCollection>: The list of batch_job_pool_collection.
batchContextId String: The OCID of batch context.
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<GetBatchBatchJobPoolsFilter>
id String: The OCID of the batch job pool.
state String: The current state of the batch job pool.

batchJobPoolCollections GetBatchBatchJobPoolsBatchJobPoolCollection[]: The list of batch_job_pool_collection.
batchContextId string: The OCID of batch context.
compartmentId string: The OCID of the compartment.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable.
filters GetBatchBatchJobPoolsFilter[]
id string: The OCID of the batch job pool.
state string: The current state of the batch job pool.

batch_job_pool_collections Sequence[GetBatchBatchJobPoolsBatchJobPoolCollection]: The list of batch_job_pool_collection.
batch_context_id str: The OCID of batch context.
compartment_id str: The OCID of the compartment.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable.
filters Sequence[GetBatchBatchJobPoolsFilter]
id str: The OCID of the batch job pool.
state str: The current state of the batch job pool.

batchJobPoolCollections List<Property Map>: The list of batch_job_pool_collection.
batchContextId String: The OCID of batch context.
compartmentId String: The OCID of the compartment.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
filters List<Property Map>
id String: The OCID of the batch job pool.
state String: The current state of the batch job pool.

Supporting Types

GetBatchBatchJobPoolsBatchJobPoolCollection

Items List<GetBatchBatchJobPoolsBatchJobPoolCollectionItem>

Items []GetBatchBatchJobPoolsBatchJobPoolCollectionItem

items List<GetBatchBatchJobPoolsBatchJobPoolCollectionItem>

items GetBatchBatchJobPoolsBatchJobPoolCollectionItem[]

items Sequence[GetBatchBatchJobPoolsBatchJobPoolCollectionItem]

items List<Property Map>

GetBatchBatchJobPoolsBatchJobPoolCollectionItem

BatchContextId string: The OCID of the batch context.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Summarized information about the batch job pool.
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the batch job pool.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

BatchContextId string: The OCID of the batch context.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Summarized information about the batch job pool.
DisplayName string: A filter to return only resources that match the given display name exactly.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the batch job pool.
State string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

batchContextId String: The OCID of the batch context.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Summarized information about the batch job pool.
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the batch job pool.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

batchContextId string: The OCID of the batch context.
compartmentId string: The OCID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: Summarized information about the batch job pool.
displayName string: A filter to return only resources that match the given display name exactly.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the batch job pool.
state string: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

batch_context_id str: The OCID of the batch context.
compartment_id str: The OCID of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: Summarized information about the batch job pool.
display_name str: A filter to return only resources that match the given display name exactly.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the batch job pool.
state str: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

batchContextId String: The OCID of the batch context.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Summarized information about the batch job pool.
displayName String: A filter to return only resources that match the given display name exactly.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the batch job pool.
state String: A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the batch job pool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the batch job pool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

GetBatchBatchJobPoolsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

oci.oci.getBatchBatchJobPools

On this page

On this page

Example Usage

Using getBatchBatchJobPools

getBatchBatchJobPools Result

Supporting Types

GetBatchBatchJobPoolsBatchJobPoolCollection

GetBatchBatchJobPoolsBatchJobPoolCollectionItem

GetBatchBatchJobPoolsFilter

Package Details

On this page

On this page