1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Marketplace
  5. getListingPackages
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.Marketplace.getListingPackages

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    This data source provides the list of Listing Packages in Oracle Cloud Infrastructure Marketplace service.

    Gets the list of packages for a listing.

    If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

    Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.

    To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testListingPackages = oci.Marketplace.getListingPackages({
        listingId: testListing.id,
        compartmentId: compartmentId,
        packageType: listingPackagePackageType,
        packageVersion: listingPackagePackageVersion,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_listing_packages = oci.Marketplace.get_listing_packages(listing_id=test_listing["id"],
        compartment_id=compartment_id,
        package_type=listing_package_package_type,
        package_version=listing_package_package_version)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Marketplace"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Marketplace.GetListingPackages(ctx, &marketplace.GetListingPackagesArgs{
    			ListingId:      testListing.Id,
    			CompartmentId:  pulumi.StringRef(compartmentId),
    			PackageType:    pulumi.StringRef(listingPackagePackageType),
    			PackageVersion: pulumi.StringRef(listingPackagePackageVersion),
    		}, 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 testListingPackages = Oci.Marketplace.GetListingPackages.Invoke(new()
        {
            ListingId = testListing.Id,
            CompartmentId = compartmentId,
            PackageType = listingPackagePackageType,
            PackageVersion = listingPackagePackageVersion,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Marketplace.MarketplaceFunctions;
    import com.pulumi.oci.Marketplace.inputs.GetListingPackagesArgs;
    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 testListingPackages = MarketplaceFunctions.getListingPackages(GetListingPackagesArgs.builder()
                .listingId(testListing.id())
                .compartmentId(compartmentId)
                .packageType(listingPackagePackageType)
                .packageVersion(listingPackagePackageVersion)
                .build());
    
        }
    }
    
    variables:
      testListingPackages:
        fn::invoke:
          Function: oci:Marketplace:getListingPackages
          Arguments:
            listingId: ${testListing.id}
            compartmentId: ${compartmentId}
            packageType: ${listingPackagePackageType}
            packageVersion: ${listingPackagePackageVersion}
    

    Using getListingPackages

    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 getListingPackages(args: GetListingPackagesArgs, opts?: InvokeOptions): Promise<GetListingPackagesResult>
    function getListingPackagesOutput(args: GetListingPackagesOutputArgs, opts?: InvokeOptions): Output<GetListingPackagesResult>
    def get_listing_packages(compartment_id: Optional[str] = None,
                             filters: Optional[Sequence[_marketplace.GetListingPackagesFilter]] = None,
                             listing_id: Optional[str] = None,
                             package_type: Optional[str] = None,
                             package_version: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetListingPackagesResult
    def get_listing_packages_output(compartment_id: Optional[pulumi.Input[str]] = None,
                             filters: Optional[pulumi.Input[Sequence[pulumi.Input[_marketplace.GetListingPackagesFilterArgs]]]] = None,
                             listing_id: Optional[pulumi.Input[str]] = None,
                             package_type: Optional[pulumi.Input[str]] = None,
                             package_version: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetListingPackagesResult]
    func GetListingPackages(ctx *Context, args *GetListingPackagesArgs, opts ...InvokeOption) (*GetListingPackagesResult, error)
    func GetListingPackagesOutput(ctx *Context, args *GetListingPackagesOutputArgs, opts ...InvokeOption) GetListingPackagesResultOutput

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

    public static class GetListingPackages 
    {
        public static Task<GetListingPackagesResult> InvokeAsync(GetListingPackagesArgs args, InvokeOptions? opts = null)
        public static Output<GetListingPackagesResult> Invoke(GetListingPackagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetListingPackagesResult> getListingPackages(GetListingPackagesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Marketplace/getListingPackages:getListingPackages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ListingId string
    The unique identifier for the listing.
    CompartmentId string
    The unique identifier for the compartment.
    Filters List<GetListingPackagesFilter>
    PackageType string
    A filter to return only packages that match the given package type exactly.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    ListingId string
    The unique identifier for the listing.
    CompartmentId string
    The unique identifier for the compartment.
    Filters []GetListingPackagesFilter
    PackageType string
    A filter to return only packages that match the given package type exactly.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    listingId String
    The unique identifier for the listing.
    compartmentId String
    The unique identifier for the compartment.
    filters List<GetListingPackagesFilter>
    packageType String
    A filter to return only packages that match the given package type exactly.
    packageVersion String
    The version of the package. Package versions are unique within a listing.
    listingId string
    The unique identifier for the listing.
    compartmentId string
    The unique identifier for the compartment.
    filters GetListingPackagesFilter[]
    packageType string
    A filter to return only packages that match the given package type exactly.
    packageVersion string
    The version of the package. Package versions are unique within a listing.
    listing_id str
    The unique identifier for the listing.
    compartment_id str
    The unique identifier for the compartment.
    filters Sequence[marketplace.GetListingPackagesFilter]
    package_type str
    A filter to return only packages that match the given package type exactly.
    package_version str
    The version of the package. Package versions are unique within a listing.
    listingId String
    The unique identifier for the listing.
    compartmentId String
    The unique identifier for the compartment.
    filters List<Property Map>
    packageType String
    A filter to return only packages that match the given package type exactly.
    packageVersion String
    The version of the package. Package versions are unique within a listing.

    getListingPackages Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListingId string
    The ID of the listing that the specified package belongs to.
    ListingPackages List<GetListingPackagesListingPackage>
    The list of listing_packages.
    CompartmentId string
    Filters List<GetListingPackagesFilter>
    PackageType string
    The specified package's type.
    PackageVersion string
    Id string
    The provider-assigned unique ID for this managed resource.
    ListingId string
    The ID of the listing that the specified package belongs to.
    ListingPackages []GetListingPackagesListingPackage
    The list of listing_packages.
    CompartmentId string
    Filters []GetListingPackagesFilter
    PackageType string
    The specified package's type.
    PackageVersion string
    id String
    The provider-assigned unique ID for this managed resource.
    listingId String
    The ID of the listing that the specified package belongs to.
    listingPackages List<GetListingPackagesListingPackage>
    The list of listing_packages.
    compartmentId String
    filters List<GetListingPackagesFilter>
    packageType String
    The specified package's type.
    packageVersion String
    id string
    The provider-assigned unique ID for this managed resource.
    listingId string
    The ID of the listing that the specified package belongs to.
    listingPackages GetListingPackagesListingPackage[]
    The list of listing_packages.
    compartmentId string
    filters GetListingPackagesFilter[]
    packageType string
    The specified package's type.
    packageVersion string
    id str
    The provider-assigned unique ID for this managed resource.
    listing_id str
    The ID of the listing that the specified package belongs to.
    listing_packages Sequence[marketplace.GetListingPackagesListingPackage]
    The list of listing_packages.
    compartment_id str
    filters Sequence[marketplace.GetListingPackagesFilter]
    package_type str
    The specified package's type.
    package_version str
    id String
    The provider-assigned unique ID for this managed resource.
    listingId String
    The ID of the listing that the specified package belongs to.
    listingPackages List<Property Map>
    The list of listing_packages.
    compartmentId String
    filters List<Property Map>
    packageType String
    The specified package's type.
    packageVersion String

    Supporting Types

    GetListingPackagesFilter

    Name string
    The name of the variable.
    Values List<string>
    Regex bool
    Name string
    The name of the variable.
    Values []string
    Regex bool
    name String
    The name of the variable.
    values List<String>
    regex Boolean
    name string
    The name of the variable.
    values string[]
    regex boolean
    name str
    The name of the variable.
    values Sequence[str]
    regex bool
    name String
    The name of the variable.
    values List<String>
    regex Boolean

    GetListingPackagesListingPackage

    ListingId string
    The unique identifier for the listing.
    OperatingSystems List<GetListingPackagesListingPackageOperatingSystem>
    The operating system used by the listing.
    PackageType string
    A filter to return only packages that match the given package type exactly.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    Pricings List<GetListingPackagesListingPackagePricing>
    The model for pricing.
    Regions List<GetListingPackagesListingPackageRegion>
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    ResourceId string
    The unique identifier for the package resource.
    TimeCreated string
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    ListingId string
    The unique identifier for the listing.
    OperatingSystems []GetListingPackagesListingPackageOperatingSystem
    The operating system used by the listing.
    PackageType string
    A filter to return only packages that match the given package type exactly.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    Pricings []GetListingPackagesListingPackagePricing
    The model for pricing.
    Regions []GetListingPackagesListingPackageRegion
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    ResourceId string
    The unique identifier for the package resource.
    TimeCreated string
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    listingId String
    The unique identifier for the listing.
    operatingSystems List<GetListingPackagesListingPackageOperatingSystem>
    The operating system used by the listing.
    packageType String
    A filter to return only packages that match the given package type exactly.
    packageVersion String
    The version of the package. Package versions are unique within a listing.
    pricings List<GetListingPackagesListingPackagePricing>
    The model for pricing.
    regions List<GetListingPackagesListingPackageRegion>
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    resourceId String
    The unique identifier for the package resource.
    timeCreated String
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    listingId string
    The unique identifier for the listing.
    operatingSystems GetListingPackagesListingPackageOperatingSystem[]
    The operating system used by the listing.
    packageType string
    A filter to return only packages that match the given package type exactly.
    packageVersion string
    The version of the package. Package versions are unique within a listing.
    pricings GetListingPackagesListingPackagePricing[]
    The model for pricing.
    regions GetListingPackagesListingPackageRegion[]
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    resourceId string
    The unique identifier for the package resource.
    timeCreated string
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    listing_id str
    The unique identifier for the listing.
    operating_systems Sequence[marketplace.GetListingPackagesListingPackageOperatingSystem]
    The operating system used by the listing.
    package_type str
    A filter to return only packages that match the given package type exactly.
    package_version str
    The version of the package. Package versions are unique within a listing.
    pricings Sequence[marketplace.GetListingPackagesListingPackagePricing]
    The model for pricing.
    regions Sequence[marketplace.GetListingPackagesListingPackageRegion]
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    resource_id str
    The unique identifier for the package resource.
    time_created str
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    listingId String
    The unique identifier for the listing.
    operatingSystems List<Property Map>
    The operating system used by the listing.
    packageType String
    A filter to return only packages that match the given package type exactly.
    packageVersion String
    The version of the package. Package versions are unique within a listing.
    pricings List<Property Map>
    The model for pricing.
    regions List<Property Map>
    The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
    resourceId String
    The unique identifier for the package resource.
    timeCreated String
    The date and time this listing package was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    GetListingPackagesListingPackageOperatingSystem

    Name string
    The name of the variable.
    Name string
    The name of the variable.
    name String
    The name of the variable.
    name string
    The name of the variable.
    name str
    The name of the variable.
    name String
    The name of the variable.

    GetListingPackagesListingPackagePricing

    Currency string
    The currency of the pricing model.
    InternationalMarketPrices List<GetListingPackagesListingPackagePricingInternationalMarketPrice>
    The model for international market pricing.
    PayGoStrategy string
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    Rate double
    The pricing rate.
    Type string
    The type of the pricing model.
    Currency string
    The currency of the pricing model.
    InternationalMarketPrices []GetListingPackagesListingPackagePricingInternationalMarketPrice
    The model for international market pricing.
    PayGoStrategy string
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    Rate float64
    The pricing rate.
    Type string
    The type of the pricing model.
    currency String
    The currency of the pricing model.
    internationalMarketPrices List<GetListingPackagesListingPackagePricingInternationalMarketPrice>
    The model for international market pricing.
    payGoStrategy String
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    rate Double
    The pricing rate.
    type String
    The type of the pricing model.
    currency string
    The currency of the pricing model.
    internationalMarketPrices GetListingPackagesListingPackagePricingInternationalMarketPrice[]
    The model for international market pricing.
    payGoStrategy string
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    rate number
    The pricing rate.
    type string
    The type of the pricing model.
    currency str
    The currency of the pricing model.
    international_market_prices Sequence[marketplace.GetListingPackagesListingPackagePricingInternationalMarketPrice]
    The model for international market pricing.
    pay_go_strategy str
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    rate float
    The pricing rate.
    type str
    The type of the pricing model.
    currency String
    The currency of the pricing model.
    internationalMarketPrices List<Property Map>
    The model for international market pricing.
    payGoStrategy String
    The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
    rate Number
    The pricing rate.
    type String
    The type of the pricing model.

    GetListingPackagesListingPackagePricingInternationalMarketPrice

    CurrencyCode string
    The currency of the pricing model.
    CurrencySymbol string
    The symbol of the currency
    Rate double
    The pricing rate.
    CurrencyCode string
    The currency of the pricing model.
    CurrencySymbol string
    The symbol of the currency
    Rate float64
    The pricing rate.
    currencyCode String
    The currency of the pricing model.
    currencySymbol String
    The symbol of the currency
    rate Double
    The pricing rate.
    currencyCode string
    The currency of the pricing model.
    currencySymbol string
    The symbol of the currency
    rate number
    The pricing rate.
    currency_code str
    The currency of the pricing model.
    currency_symbol str
    The symbol of the currency
    rate float
    The pricing rate.
    currencyCode String
    The currency of the pricing model.
    currencySymbol String
    The symbol of the currency
    rate Number
    The pricing rate.

    GetListingPackagesListingPackageRegion

    Code string
    A code assigned to the item.
    Countries List<GetListingPackagesListingPackageRegionCountry>
    Countries in the region.
    Name string
    The name of the variable.
    Code string
    A code assigned to the item.
    Countries []GetListingPackagesListingPackageRegionCountry
    Countries in the region.
    Name string
    The name of the variable.
    code String
    A code assigned to the item.
    countries List<GetListingPackagesListingPackageRegionCountry>
    Countries in the region.
    name String
    The name of the variable.
    code string
    A code assigned to the item.
    countries GetListingPackagesListingPackageRegionCountry[]
    Countries in the region.
    name string
    The name of the variable.
    code str
    A code assigned to the item.
    countries Sequence[marketplace.GetListingPackagesListingPackageRegionCountry]
    Countries in the region.
    name str
    The name of the variable.
    code String
    A code assigned to the item.
    countries List<Property Map>
    Countries in the region.
    name String
    The name of the variable.

    GetListingPackagesListingPackageRegionCountry

    Code string
    A code assigned to the item.
    Name string
    The name of the variable.
    Code string
    A code assigned to the item.
    Name string
    The name of the variable.
    code String
    A code assigned to the item.
    name String
    The name of the variable.
    code string
    A code assigned to the item.
    name string
    The name of the variable.
    code str
    A code assigned to the item.
    name str
    The name of the variable.
    code String
    A code assigned to the item.
    name String
    The name of the variable.

    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 v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi