Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OneSubsription
  5. getCommitments
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.OneSubsription.getCommitments

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides the list of Commitments in Oracle Cloud Infrastructure Onesubscription service.

This list API returns all commitments for a particular Subscribed Service

Example Usage

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

const testCommitments = oci.OneSubsription.getCommitments({
    compartmentId: compartmentId,
    subscribedServiceId: testSubscribedService.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_commitments = oci.OneSubsription.get_commitments(compartment_id=compartment_id,
    subscribed_service_id=test_subscribed_service["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := onesubsription.GetCommitments(ctx, &onesubsription.GetCommitmentsArgs{
			CompartmentId:       compartmentId,
			SubscribedServiceId: testSubscribedService.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCommitments = Oci.OneSubsription.GetCommitments.Invoke(new()
    {
        CompartmentId = compartmentId,
        SubscribedServiceId = testSubscribedService.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OneSubsription.OneSubsriptionFunctions;
import com.pulumi.oci.OneSubsription.inputs.GetCommitmentsArgs;
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 testCommitments = OneSubsriptionFunctions.getCommitments(GetCommitmentsArgs.builder()
            .compartmentId(compartmentId)
            .subscribedServiceId(testSubscribedService.id())
            .build());

    }
}
Copy
variables:
  testCommitments:
    fn::invoke:
      function: oci:OneSubsription:getCommitments
      arguments:
        compartmentId: ${compartmentId}
        subscribedServiceId: ${testSubscribedService.id}
Copy

Using getCommitments

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 getCommitments(args: GetCommitmentsArgs, opts?: InvokeOptions): Promise<GetCommitmentsResult>
function getCommitmentsOutput(args: GetCommitmentsOutputArgs, opts?: InvokeOptions): Output<GetCommitmentsResult>
Copy
def get_commitments(compartment_id: Optional[str] = None,
                    filters: Optional[Sequence[_onesubsription.GetCommitmentsFilter]] = None,
                    subscribed_service_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCommitmentsResult
def get_commitments_output(compartment_id: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_onesubsription.GetCommitmentsFilterArgs]]]] = None,
                    subscribed_service_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCommitmentsResult]
Copy
func GetCommitments(ctx *Context, args *GetCommitmentsArgs, opts ...InvokeOption) (*GetCommitmentsResult, error)
func GetCommitmentsOutput(ctx *Context, args *GetCommitmentsOutputArgs, opts ...InvokeOption) GetCommitmentsResultOutput
Copy

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

public static class GetCommitments 
{
    public static Task<GetCommitmentsResult> InvokeAsync(GetCommitmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetCommitmentsResult> Invoke(GetCommitmentsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCommitmentsResult> getCommitments(GetCommitmentsArgs args, InvokeOptions options)
public static Output<GetCommitmentsResult> getCommitments(GetCommitmentsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:OneSubsription/getCommitments:getCommitments
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the root compartment.
SubscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
Filters Changes to this property will trigger replacement. List<GetCommitmentsFilter>
CompartmentId This property is required. string
The OCID of the root compartment.
SubscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
Filters Changes to this property will trigger replacement. []GetCommitmentsFilter
compartmentId This property is required. String
The OCID of the root compartment.
subscribedServiceId This property is required. String
This param is used to get the commitments for a particular subscribed service
filters Changes to this property will trigger replacement. List<GetCommitmentsFilter>
compartmentId This property is required. string
The OCID of the root compartment.
subscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
filters Changes to this property will trigger replacement. GetCommitmentsFilter[]
compartment_id This property is required. str
The OCID of the root compartment.
subscribed_service_id This property is required. str
This param is used to get the commitments for a particular subscribed service
filters Changes to this property will trigger replacement. Sequence[onesubsription.GetCommitmentsFilter]
compartmentId This property is required. String
The OCID of the root compartment.
subscribedServiceId This property is required. String
This param is used to get the commitments for a particular subscribed service
filters Changes to this property will trigger replacement. List<Property Map>

getCommitments Result

The following output properties are available:

Commitments List<GetCommitmentsCommitment>
The list of commitments.
CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
SubscribedServiceId string
SPM internal Subscribed Service ID
Filters List<GetCommitmentsFilter>
Commitments []GetCommitmentsCommitment
The list of commitments.
CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
SubscribedServiceId string
SPM internal Subscribed Service ID
Filters []GetCommitmentsFilter
commitments List<GetCommitmentsCommitment>
The list of commitments.
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
subscribedServiceId String
SPM internal Subscribed Service ID
filters List<GetCommitmentsFilter>
commitments GetCommitmentsCommitment[]
The list of commitments.
compartmentId string
id string
The provider-assigned unique ID for this managed resource.
subscribedServiceId string
SPM internal Subscribed Service ID
filters GetCommitmentsFilter[]
commitments Sequence[onesubsription.GetCommitmentsCommitment]
The list of commitments.
compartment_id str
id str
The provider-assigned unique ID for this managed resource.
subscribed_service_id str
SPM internal Subscribed Service ID
filters Sequence[onesubsription.GetCommitmentsFilter]
commitments List<Property Map>
The list of commitments.
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
subscribedServiceId String
SPM internal Subscribed Service ID
filters List<Property Map>

Supporting Types

GetCommitmentsCommitment

AvailableAmount This property is required. string
Commitment available amount
FundedAllocationValue This property is required. string
Funded Allocation line value example: 12000.00
Id This property is required. string
SPM internal Commitment ID
Quantity This property is required. string
Commitment quantity
SubscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
TimeEnd This property is required. string
Commitment end date
TimeStart This property is required. string
Commitment start date
UsedAmount This property is required. string
Commitment used amount
AvailableAmount This property is required. string
Commitment available amount
FundedAllocationValue This property is required. string
Funded Allocation line value example: 12000.00
Id This property is required. string
SPM internal Commitment ID
Quantity This property is required. string
Commitment quantity
SubscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
TimeEnd This property is required. string
Commitment end date
TimeStart This property is required. string
Commitment start date
UsedAmount This property is required. string
Commitment used amount
availableAmount This property is required. String
Commitment available amount
fundedAllocationValue This property is required. String
Funded Allocation line value example: 12000.00
id This property is required. String
SPM internal Commitment ID
quantity This property is required. String
Commitment quantity
subscribedServiceId This property is required. String
This param is used to get the commitments for a particular subscribed service
timeEnd This property is required. String
Commitment end date
timeStart This property is required. String
Commitment start date
usedAmount This property is required. String
Commitment used amount
availableAmount This property is required. string
Commitment available amount
fundedAllocationValue This property is required. string
Funded Allocation line value example: 12000.00
id This property is required. string
SPM internal Commitment ID
quantity This property is required. string
Commitment quantity
subscribedServiceId This property is required. string
This param is used to get the commitments for a particular subscribed service
timeEnd This property is required. string
Commitment end date
timeStart This property is required. string
Commitment start date
usedAmount This property is required. string
Commitment used amount
available_amount This property is required. str
Commitment available amount
funded_allocation_value This property is required. str
Funded Allocation line value example: 12000.00
id This property is required. str
SPM internal Commitment ID
quantity This property is required. str
Commitment quantity
subscribed_service_id This property is required. str
This param is used to get the commitments for a particular subscribed service
time_end This property is required. str
Commitment end date
time_start This property is required. str
Commitment start date
used_amount This property is required. str
Commitment used amount
availableAmount This property is required. String
Commitment available amount
fundedAllocationValue This property is required. String
Funded Allocation line value example: 12000.00
id This property is required. String
SPM internal Commitment ID
quantity This property is required. String
Commitment quantity
subscribedServiceId This property is required. String
This param is used to get the commitments for a particular subscribed service
timeEnd This property is required. String
Commitment end date
timeStart This property is required. String
Commitment start date
usedAmount This property is required. String
Commitment used amount

GetCommitmentsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. 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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci