Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getCommitments

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

This list API returns all commitments for a particular Subscribed Service

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testCommitments = Oci.OsubSubscription.GetCommitments.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        SubscribedServiceId = oci_core_service.Test_service.Id,
        XOneGatewaySubscriptionId = @var.Commitment_x_one_gateway_subscription_id,
        XOneOriginRegion = @var.Commitment_x_one_origin_region,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := OsubSubscription.GetCommitments(ctx, &osubsubscription.GetCommitmentsArgs{
			CompartmentId:             _var.Compartment_id,
			SubscribedServiceId:       oci_core_service.Test_service.Id,
			XOneGatewaySubscriptionId: pulumi.StringRef(_var.Commitment_x_one_gateway_subscription_id),
			XOneOriginRegion:          pulumi.StringRef(_var.Commitment_x_one_origin_region),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OsubSubscription.OsubSubscriptionFunctions;
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 = OsubSubscriptionFunctions.getCommitments(GetCommitmentsArgs.builder()
            .compartmentId(var_.compartment_id())
            .subscribedServiceId(oci_core_service.test_service().id())
            .xOneGatewaySubscriptionId(var_.commitment_x_one_gateway_subscription_id())
            .xOneOriginRegion(var_.commitment_x_one_origin_region())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_commitments = oci.OsubSubscription.get_commitments(compartment_id=var["compartment_id"],
    subscribed_service_id=oci_core_service["test_service"]["id"],
    x_one_gateway_subscription_id=var["commitment_x_one_gateway_subscription_id"],
    x_one_origin_region=var["commitment_x_one_origin_region"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCommitments = oci.OsubSubscription.getCommitments({
    compartmentId: _var.compartment_id,
    subscribedServiceId: oci_core_service.test_service.id,
    xOneGatewaySubscriptionId: _var.commitment_x_one_gateway_subscription_id,
    xOneOriginRegion: _var.commitment_x_one_origin_region,
});
variables:
  testCommitments:
    Fn::Invoke:
      Function: oci:OsubSubscription:getCommitments
      Arguments:
        compartmentId: ${var.compartment_id}
        subscribedServiceId: ${oci_core_service.test_service.id}
        xOneGatewaySubscriptionId: ${var.commitment_x_one_gateway_subscription_id}
        xOneOriginRegion: ${var.commitment_x_one_origin_region}

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

> 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)
}
public static CompletableFuture<GetCommitmentsResult> getCommitments(GetCommitmentsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:OsubSubscription/getCommitments:getCommitments
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

SubscribedServiceId string

This param is used to get the commitments for a particular subscribed service

Filters List<GetCommitmentsFilter>
XOneGatewaySubscriptionId string

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

XOneOriginRegion string

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

CompartmentId string

The OCID of the compartment.

SubscribedServiceId string

This param is used to get the commitments for a particular subscribed service

Filters []GetCommitmentsFilter
XOneGatewaySubscriptionId string

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

XOneOriginRegion string

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

compartmentId String

The OCID of the compartment.

subscribedServiceId String

This param is used to get the commitments for a particular subscribed service

filters List<GetCommitmentsFilter>
xOneGatewaySubscriptionId String

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

xOneOriginRegion String

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

compartmentId string

The OCID of the compartment.

subscribedServiceId string

This param is used to get the commitments for a particular subscribed service

filters GetCommitmentsFilter[]
xOneGatewaySubscriptionId string

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

xOneOriginRegion string

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

compartment_id str

The OCID of the compartment.

subscribed_service_id str

This param is used to get the commitments for a particular subscribed service

filters GetCommitmentsFilter]
x_one_gateway_subscription_id str

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

x_one_origin_region str

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

compartmentId String

The OCID of the compartment.

subscribedServiceId String

This param is used to get the commitments for a particular subscribed service

filters List<Property Map>
xOneGatewaySubscriptionId String

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

xOneOriginRegion String

The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

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
Filters List<GetCommitmentsFilter>
XOneGatewaySubscriptionId string
XOneOriginRegion string
Commitments []GetCommitmentsCommitment

The list of commitments.

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

SubscribedServiceId string
Filters []GetCommitmentsFilter
XOneGatewaySubscriptionId string
XOneOriginRegion string
commitments List<GetCommitmentsCommitment>

The list of commitments.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

subscribedServiceId String
filters List<GetCommitmentsFilter>
xOneGatewaySubscriptionId String
xOneOriginRegion String
commitments GetCommitmentsCommitment[]

The list of commitments.

compartmentId string
id string

The provider-assigned unique ID for this managed resource.

subscribedServiceId string
filters GetCommitmentsFilter[]
xOneGatewaySubscriptionId string
xOneOriginRegion string
commitments GetCommitmentsCommitment]

The list of commitments.

compartment_id str
id str

The provider-assigned unique ID for this managed resource.

subscribed_service_id str
filters GetCommitmentsFilter]
x_one_gateway_subscription_id str
x_one_origin_region str
commitments List<Property Map>

The list of commitments.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

subscribedServiceId String
filters List<Property Map>
xOneGatewaySubscriptionId String
xOneOriginRegion String

Supporting Types

GetCommitmentsCommitment

AvailableAmount string

Commitment available amount

FundedAllocationValue string

Funded Allocation line value example: 12000.00

Id string

SPM internal Commitment ID

Quantity string

Commitment quantity

TimeEnd string

Commitment end date

TimeStart string

Commitment start date

UsedAmount string

Commitment used amount

AvailableAmount string

Commitment available amount

FundedAllocationValue string

Funded Allocation line value example: 12000.00

Id string

SPM internal Commitment ID

Quantity string

Commitment quantity

TimeEnd string

Commitment end date

TimeStart string

Commitment start date

UsedAmount string

Commitment used amount

availableAmount String

Commitment available amount

fundedAllocationValue String

Funded Allocation line value example: 12000.00

id String

SPM internal Commitment ID

quantity String

Commitment quantity

timeEnd String

Commitment end date

timeStart String

Commitment start date

usedAmount String

Commitment used amount

availableAmount string

Commitment available amount

fundedAllocationValue string

Funded Allocation line value example: 12000.00

id string

SPM internal Commitment ID

quantity string

Commitment quantity

timeEnd string

Commitment end date

timeStart string

Commitment start date

usedAmount string

Commitment used amount

available_amount str

Commitment available amount

funded_allocation_value str

Funded Allocation line value example: 12000.00

id str

SPM internal Commitment ID

quantity str

Commitment quantity

time_end str

Commitment end date

time_start str

Commitment start date

used_amount str

Commitment used amount

availableAmount String

Commitment available amount

fundedAllocationValue String

Funded Allocation line value example: 12000.00

id String

SPM internal Commitment ID

quantity String

Commitment quantity

timeEnd String

Commitment end date

timeStart String

Commitment start date

usedAmount String

Commitment used amount

GetCommitmentsFilter

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.