Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LicenseManager
  5. getProductLicenses
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.LicenseManager.getProductLicenses

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Product Licenses in Oracle Cloud Infrastructure License Manager service.

    Retrieves all the product licenses from a given compartment.

    Example Usage

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

const testProductLicenses = oci.LicenseManager.getProductLicenses({
    compartmentId: compartmentId,
    isCompartmentIdInSubtree: productLicenseIsCompartmentIdInSubtree,
});

    import pulumi
import pulumi_oci as oci

test_product_licenses = oci.LicenseManager.get_product_licenses(compartment_id=compartment_id,
    is_compartment_id_in_subtree=product_license_is_compartment_id_in_subtree)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LicenseManager.GetProductLicenses(ctx, &licensemanager.GetProductLicensesArgs{
			CompartmentId:            compartmentId,
			IsCompartmentIdInSubtree: pulumi.BoolRef(productLicenseIsCompartmentIdInSubtree),
		}, 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 testProductLicenses = Oci.LicenseManager.GetProductLicenses.Invoke(new()
    {
        CompartmentId = compartmentId,
        IsCompartmentIdInSubtree = productLicenseIsCompartmentIdInSubtree,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LicenseManager.LicenseManagerFunctions;
import com.pulumi.oci.LicenseManager.inputs.GetProductLicensesArgs;
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 testProductLicenses = LicenseManagerFunctions.getProductLicenses(GetProductLicensesArgs.builder()
            .compartmentId(compartmentId)
            .isCompartmentIdInSubtree(productLicenseIsCompartmentIdInSubtree)
            .build());

    }
}

    variables:
  testProductLicenses:
    fn::invoke:
      Function: oci:LicenseManager:getProductLicenses
      Arguments:
        compartmentId: ${compartmentId}
        isCompartmentIdInSubtree: ${productLicenseIsCompartmentIdInSubtree}

    Using getProductLicenses

    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 getProductLicenses(args: GetProductLicensesArgs, opts?: InvokeOptions): Promise<GetProductLicensesResult>
function getProductLicensesOutput(args: GetProductLicensesOutputArgs, opts?: InvokeOptions): Output<GetProductLicensesResult>
    def get_product_licenses(compartment_id: Optional[str] = None,
                         filters: Optional[Sequence[_licensemanager.GetProductLicensesFilter]] = None,
                         is_compartment_id_in_subtree: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProductLicensesResult
def get_product_licenses_output(compartment_id: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_licensemanager.GetProductLicensesFilterArgs]]]] = None,
                         is_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProductLicensesResult]
    func GetProductLicenses(ctx *Context, args *GetProductLicensesArgs, opts ...InvokeOption) (*GetProductLicensesResult, error)
func GetProductLicensesOutput(ctx *Context, args *GetProductLicensesOutputArgs, opts ...InvokeOption) GetProductLicensesResultOutput

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

    public static class GetProductLicenses 
{
    public static Task<GetProductLicensesResult> InvokeAsync(GetProductLicensesArgs args, InvokeOptions? opts = null)
    public static Output<GetProductLicensesResult> Invoke(GetProductLicensesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProductLicensesResult> getProductLicenses(GetProductLicensesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:LicenseManager/getProductLicenses:getProductLicenses
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    Filters List<GetProductLicensesFilter>
    IsCompartmentIdInSubtree bool
    Indicates if the given compartment is the root compartment.
    CompartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    Filters []GetProductLicensesFilter
    IsCompartmentIdInSubtree bool
    Indicates if the given compartment is the root compartment.
    compartmentId String
    The compartment OCID used for the license record, product license, and configuration.
    filters List<GetProductLicensesFilter>
    isCompartmentIdInSubtree Boolean
    Indicates if the given compartment is the root compartment.
    compartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    filters GetProductLicensesFilter[]
    isCompartmentIdInSubtree boolean
    Indicates if the given compartment is the root compartment.
    compartment_id str
    The compartment OCID used for the license record, product license, and configuration.
    filters Sequence[licensemanager.GetProductLicensesFilter]
    is_compartment_id_in_subtree bool
    Indicates if the given compartment is the root compartment.
    compartmentId String
    The compartment OCID used for the license record, product license, and configuration.
    filters List<Property Map>
    isCompartmentIdInSubtree Boolean
    Indicates if the given compartment is the root compartment.

    getProductLicenses Result

    The following output properties are available:

    CompartmentId string
    The compartment OCID where the product license is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProductLicenseCollections List<GetProductLicensesProductLicenseCollection>
    The list of product_license_collection.
    Filters List<GetProductLicensesFilter>
    IsCompartmentIdInSubtree bool
    CompartmentId string
    The compartment OCID where the product license is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProductLicenseCollections []GetProductLicensesProductLicenseCollection
    The list of product_license_collection.
    Filters []GetProductLicensesFilter
    IsCompartmentIdInSubtree bool
    compartmentId String
    The compartment OCID where the product license is created.
    id String
    The provider-assigned unique ID for this managed resource.
    productLicenseCollections List<GetProductLicensesProductLicenseCollection>
    The list of product_license_collection.
    filters List<GetProductLicensesFilter>
    isCompartmentIdInSubtree Boolean
    compartmentId string
    The compartment OCID where the product license is created.
    id string
    The provider-assigned unique ID for this managed resource.
    productLicenseCollections GetProductLicensesProductLicenseCollection[]
    The list of product_license_collection.
    filters GetProductLicensesFilter[]
    isCompartmentIdInSubtree boolean
    compartment_id str
    The compartment OCID where the product license is created.
    id str
    The provider-assigned unique ID for this managed resource.
    product_license_collections Sequence[licensemanager.GetProductLicensesProductLicenseCollection]
    The list of product_license_collection.
    filters Sequence[licensemanager.GetProductLicensesFilter]
    is_compartment_id_in_subtree bool
    compartmentId String
    The compartment OCID where the product license is created.
    id String
    The provider-assigned unique ID for this managed resource.
    productLicenseCollections List<Property Map>
    The list of product_license_collection.
    filters List<Property Map>
    isCompartmentIdInSubtree Boolean

    Supporting Types

    GetProductLicensesFilter

    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

    GetProductLicensesProductLicenseCollection

    GetProductLicensesProductLicenseCollectionItem

    ActiveLicenseRecordCount int
    The number of active license records associated with the product license.
    CompartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    License record name
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The image ID associated with the product license.
    Images List<GetProductLicensesProductLicenseCollectionItemImage>
    The images associated with the product license.
    IsOverSubscribed bool
    Specifies whether or not the product license is oversubscribed.
    IsUnlimited bool
    Specifies if the license unit count is unlimited.
    IsVendorOracle bool
    Specifies whether the vendor is Oracle or a third party.
    LicenseUnit string
    The product license unit.
    State string
    The current product license state.
    Status string
    The current product license status.
    StatusDescription string
    Status description for the current product license status.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the product license was created. An RFC 3339-formatted datetime string.
    TimeUpdated string
    The time the product license was updated. An RFC 3339-formatted datetime string.
    TotalActiveLicenseUnitCount int
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    TotalLicenseRecordCount int
    The number of license records associated with the product license.
    TotalLicenseUnitsConsumed double
    The number of license units consumed. Updated after each allocation run.
    VendorName string
    The vendor of the ProductLicense
    ActiveLicenseRecordCount int
    The number of active license records associated with the product license.
    CompartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    License record name
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The image ID associated with the product license.
    Images []GetProductLicensesProductLicenseCollectionItemImage
    The images associated with the product license.
    IsOverSubscribed bool
    Specifies whether or not the product license is oversubscribed.
    IsUnlimited bool
    Specifies if the license unit count is unlimited.
    IsVendorOracle bool
    Specifies whether the vendor is Oracle or a third party.
    LicenseUnit string
    The product license unit.
    State string
    The current product license state.
    Status string
    The current product license status.
    StatusDescription string
    Status description for the current product license status.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the product license was created. An RFC 3339-formatted datetime string.
    TimeUpdated string
    The time the product license was updated. An RFC 3339-formatted datetime string.
    TotalActiveLicenseUnitCount int
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    TotalLicenseRecordCount int
    The number of license records associated with the product license.
    TotalLicenseUnitsConsumed float64
    The number of license units consumed. Updated after each allocation run.
    VendorName string
    The vendor of the ProductLicense
    activeLicenseRecordCount Integer
    The number of active license records associated with the product license.
    compartmentId String
    The compartment OCID used for the license record, product license, and configuration.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    License record name
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The image ID associated with the product license.
    images List<GetProductLicensesProductLicenseCollectionItemImage>
    The images associated with the product license.
    isOverSubscribed Boolean
    Specifies whether or not the product license is oversubscribed.
    isUnlimited Boolean
    Specifies if the license unit count is unlimited.
    isVendorOracle Boolean
    Specifies whether the vendor is Oracle or a third party.
    licenseUnit String
    The product license unit.
    state String
    The current product license state.
    status String
    The current product license status.
    statusDescription String
    Status description for the current product license status.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the product license was created. An RFC 3339-formatted datetime string.
    timeUpdated String
    The time the product license was updated. An RFC 3339-formatted datetime string.
    totalActiveLicenseUnitCount Integer
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    totalLicenseRecordCount Integer
    The number of license records associated with the product license.
    totalLicenseUnitsConsumed Double
    The number of license units consumed. Updated after each allocation run.
    vendorName String
    The vendor of the ProductLicense
    activeLicenseRecordCount number
    The number of active license records associated with the product license.
    compartmentId string
    The compartment OCID used for the license record, product license, and configuration.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    License record name
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The image ID associated with the product license.
    images GetProductLicensesProductLicenseCollectionItemImage[]
    The images associated with the product license.
    isOverSubscribed boolean
    Specifies whether or not the product license is oversubscribed.
    isUnlimited boolean
    Specifies if the license unit count is unlimited.
    isVendorOracle boolean
    Specifies whether the vendor is Oracle or a third party.
    licenseUnit string
    The product license unit.
    state string
    The current product license state.
    status string
    The current product license status.
    statusDescription string
    Status description for the current product license status.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the product license was created. An RFC 3339-formatted datetime string.
    timeUpdated string
    The time the product license was updated. An RFC 3339-formatted datetime string.
    totalActiveLicenseUnitCount number
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    totalLicenseRecordCount number
    The number of license records associated with the product license.
    totalLicenseUnitsConsumed number
    The number of license units consumed. Updated after each allocation run.
    vendorName string
    The vendor of the ProductLicense
    active_license_record_count int
    The number of active license records associated with the product license.
    compartment_id str
    The compartment OCID used for the license record, product license, and configuration.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    License record name
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The image ID associated with the product license.
    images Sequence[licensemanager.GetProductLicensesProductLicenseCollectionItemImage]
    The images associated with the product license.
    is_over_subscribed bool
    Specifies whether or not the product license is oversubscribed.
    is_unlimited bool
    Specifies if the license unit count is unlimited.
    is_vendor_oracle bool
    Specifies whether the vendor is Oracle or a third party.
    license_unit str
    The product license unit.
    state str
    The current product license state.
    status str
    The current product license status.
    status_description str
    Status description for the current product license status.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the product license was created. An RFC 3339-formatted datetime string.
    time_updated str
    The time the product license was updated. An RFC 3339-formatted datetime string.
    total_active_license_unit_count int
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    total_license_record_count int
    The number of license records associated with the product license.
    total_license_units_consumed float
    The number of license units consumed. Updated after each allocation run.
    vendor_name str
    The vendor of the ProductLicense
    activeLicenseRecordCount Number
    The number of active license records associated with the product license.
    compartmentId String
    The compartment OCID used for the license record, product license, and configuration.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    License record name
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The image ID associated with the product license.
    images List<Property Map>
    The images associated with the product license.
    isOverSubscribed Boolean
    Specifies whether or not the product license is oversubscribed.
    isUnlimited Boolean
    Specifies if the license unit count is unlimited.
    isVendorOracle Boolean
    Specifies whether the vendor is Oracle or a third party.
    licenseUnit String
    The product license unit.
    state String
    The current product license state.
    status String
    The current product license status.
    statusDescription String
    Status description for the current product license status.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the product license was created. An RFC 3339-formatted datetime string.
    timeUpdated String
    The time the product license was updated. An RFC 3339-formatted datetime string.
    totalActiveLicenseUnitCount Number
    The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.
    totalLicenseRecordCount Number
    The number of license records associated with the product license.
    totalLicenseUnitsConsumed Number
    The number of license units consumed. Updated after each allocation run.
    vendorName String
    The vendor of the ProductLicense

    GetProductLicensesProductLicenseCollectionItemImage

    Id string
    The image ID associated with the product license.
    ListingId string
    The image listing ID.
    ListingName string
    The listing name associated with the product license.
    PackageVersion string
    The image package version.
    Publisher string
    The image publisher.
    Id string
    The image ID associated with the product license.
    ListingId string
    The image listing ID.
    ListingName string
    The listing name associated with the product license.
    PackageVersion string
    The image package version.
    Publisher string
    The image publisher.
    id String
    The image ID associated with the product license.
    listingId String
    The image listing ID.
    listingName String
    The listing name associated with the product license.
    packageVersion String
    The image package version.
    publisher String
    The image publisher.
    id string
    The image ID associated with the product license.
    listingId string
    The image listing ID.
    listingName string
    The listing name associated with the product license.
    packageVersion string
    The image package version.
    publisher string
    The image publisher.
    id str
    The image ID associated with the product license.
    listing_id str
    The image listing ID.
    listing_name str
    The listing name associated with the product license.
    package_version str
    The image package version.
    publisher str
    The image publisher.
    id String
    The image ID associated with the product license.
    listingId String
    The image listing ID.
    listingName String
    The listing name associated with the product license.
    packageVersion String
    The image package version.
    publisher String
    The image publisher.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci