Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OsManagementHub
  5. getEntitlements
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.OsManagementHub.getEntitlements

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Entitlements in Oracle Cloud Infrastructure Os Management Hub service.

    Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its Customer Support Identifier (CSI), and vendor name.

    Example Usage

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

const testEntitlements = oci.OsManagementHub.getEntitlements({
    compartmentId: compartmentId,
    csi: entitlementCsi,
    vendorName: entitlementVendorName,
});

    import pulumi
import pulumi_oci as oci

test_entitlements = oci.OsManagementHub.get_entitlements(compartment_id=compartment_id,
    csi=entitlement_csi,
    vendor_name=entitlement_vendor_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := osmanagementhub.GetEntitlements(ctx, &osmanagementhub.GetEntitlementsArgs{
			CompartmentId: compartmentId,
			Csi:           pulumi.StringRef(entitlementCsi),
			VendorName:    pulumi.StringRef(entitlementVendorName),
		}, 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 testEntitlements = Oci.OsManagementHub.GetEntitlements.Invoke(new()
    {
        CompartmentId = compartmentId,
        Csi = entitlementCsi,
        VendorName = entitlementVendorName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OsManagementHub.OsManagementHubFunctions;
import com.pulumi.oci.OsManagementHub.inputs.GetEntitlementsArgs;
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 testEntitlements = OsManagementHubFunctions.getEntitlements(GetEntitlementsArgs.builder()
            .compartmentId(compartmentId)
            .csi(entitlementCsi)
            .vendorName(entitlementVendorName)
            .build());

    }
}

    variables:
  testEntitlements:
    fn::invoke:
      function: oci:OsManagementHub:getEntitlements
      arguments:
        compartmentId: ${compartmentId}
        csi: ${entitlementCsi}
        vendorName: ${entitlementVendorName}

    Using getEntitlements

    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 getEntitlements(args: GetEntitlementsArgs, opts?: InvokeOptions): Promise<GetEntitlementsResult>
function getEntitlementsOutput(args: GetEntitlementsOutputArgs, opts?: InvokeOptions): Output<GetEntitlementsResult>
    def get_entitlements(compartment_id: Optional[str] = None,
                     csi: Optional[str] = None,
                     filters: Optional[Sequence[GetEntitlementsFilter]] = None,
                     vendor_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEntitlementsResult
def get_entitlements_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     csi: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetEntitlementsFilterArgs]]]] = None,
                     vendor_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEntitlementsResult]
    func GetEntitlements(ctx *Context, args *GetEntitlementsArgs, opts ...InvokeOption) (*GetEntitlementsResult, error)
func GetEntitlementsOutput(ctx *Context, args *GetEntitlementsOutputArgs, opts ...InvokeOption) GetEntitlementsResultOutput

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

    public static class GetEntitlements 
{
    public static Task<GetEntitlementsResult> InvokeAsync(GetEntitlementsArgs args, InvokeOptions? opts = null)
    public static Output<GetEntitlementsResult> Invoke(GetEntitlementsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEntitlementsResult> getEntitlements(GetEntitlementsArgs args, InvokeOptions options)
public static Output<GetEntitlementsResult> getEntitlements(GetEntitlementsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:OsManagementHub/getEntitlements:getEntitlements
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    Filters List<GetEntitlementsFilter>
    VendorName string
    A filter to return only resources that match the given vendor name.
    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    Filters []GetEntitlementsFilter
    VendorName string
    A filter to return only resources that match the given vendor name.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    filters List<GetEntitlementsFilter>
    vendorName String
    A filter to return only resources that match the given vendor name.
    compartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    filters GetEntitlementsFilter[]
    vendorName string
    A filter to return only resources that match the given vendor name.
    compartment_id str
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi str
    A filter to return entitlements that match the given customer support identifier (CSI).
    filters Sequence[GetEntitlementsFilter]
    vendor_name str
    A filter to return only resources that match the given vendor name.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    filters List<Property Map>
    vendorName String
    A filter to return only resources that match the given vendor name.

    getEntitlements Result

    The following output properties are available:

    CompartmentId string
    The OCID of the tenancy containing the entitlement.
    EntitlementCollections List<GetEntitlementsEntitlementCollection>
    The list of entitlement_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Csi string
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    Filters List<GetEntitlementsFilter>
    VendorName string
    The vendor for the entitlement.
    CompartmentId string
    The OCID of the tenancy containing the entitlement.
    EntitlementCollections []GetEntitlementsEntitlementCollection
    The list of entitlement_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Csi string
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    Filters []GetEntitlementsFilter
    VendorName string
    The vendor for the entitlement.
    compartmentId String
    The OCID of the tenancy containing the entitlement.
    entitlementCollections List<GetEntitlementsEntitlementCollection>
    The list of entitlement_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    csi String
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    filters List<GetEntitlementsFilter>
    vendorName String
    The vendor for the entitlement.
    compartmentId string
    The OCID of the tenancy containing the entitlement.
    entitlementCollections GetEntitlementsEntitlementCollection[]
    The list of entitlement_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    csi string
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    filters GetEntitlementsFilter[]
    vendorName string
    The vendor for the entitlement.
    compartment_id str
    The OCID of the tenancy containing the entitlement.
    entitlement_collections Sequence[GetEntitlementsEntitlementCollection]
    The list of entitlement_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    csi str
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    filters Sequence[GetEntitlementsFilter]
    vendor_name str
    The vendor for the entitlement.
    compartmentId String
    The OCID of the tenancy containing the entitlement.
    entitlementCollections List<Property Map>
    The list of entitlement_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    csi String
    The Customer Support Identifier (CSI) which unlocks the software sources. The CSI is is a unique key given to a customer and it uniquely identifies the entitlement.
    filters List<Property Map>
    vendorName String
    The vendor for the entitlement.

    Supporting Types

    GetEntitlementsEntitlementCollection

    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    Items List<GetEntitlementsEntitlementCollectionItem>
    List of entitlements.
    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    Items []GetEntitlementsEntitlementCollectionItem
    List of entitlements.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    items List<GetEntitlementsEntitlementCollectionItem>
    List of entitlements.
    compartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    items GetEntitlementsEntitlementCollectionItem[]
    List of entitlements.
    compartment_id str
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi str
    A filter to return entitlements that match the given customer support identifier (CSI).
    items Sequence[GetEntitlementsEntitlementCollectionItem]
    List of entitlements.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    items List<Property Map>
    List of entitlements.

    GetEntitlementsEntitlementCollectionItem

    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    VendorName string
    A filter to return only resources that match the given vendor name.
    CompartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    Csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    VendorName string
    A filter to return only resources that match the given vendor name.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    vendorName String
    A filter to return only resources that match the given vendor name.
    compartmentId string
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi string
    A filter to return entitlements that match the given customer support identifier (CSI).
    vendorName string
    A filter to return only resources that match the given vendor name.
    compartment_id str
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi str
    A filter to return entitlements that match the given customer support identifier (CSI).
    vendor_name str
    A filter to return only resources that match the given vendor name.
    compartmentId String
    The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment.
    csi String
    A filter to return entitlements that match the given customer support identifier (CSI).
    vendorName String
    A filter to return only resources that match the given vendor name.

    GetEntitlementsFilter

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci