1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Marketplace
  5. getListingPackage
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Marketplace.getListingPackage

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This data source provides details about a specific Listing Package resource in Oracle Cloud Infrastructure Marketplace service.

    Get the details of the specified version of a package, including information needed to launch the package.

    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

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testListingPackage = Oci.Marketplace.GetListingPackage.Invoke(new()
        {
            ListingId = oci_marketplace_listing.Test_listing.Id,
            PackageVersion = @var.Listing_package_package_version,
            CompartmentId = @var.Compartment_id,
        });
    
    });
    
    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.GetListingPackage(ctx, &marketplace.GetListingPackageArgs{
    			ListingId:      oci_marketplace_listing.Test_listing.Id,
    			PackageVersion: _var.Listing_package_package_version,
    			CompartmentId:  pulumi.StringRef(_var.Compartment_id),
    		}, 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.Marketplace.MarketplaceFunctions;
    import com.pulumi.oci.Marketplace.inputs.GetListingPackageArgs;
    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 testListingPackage = MarketplaceFunctions.getListingPackage(GetListingPackageArgs.builder()
                .listingId(oci_marketplace_listing.test_listing().id())
                .packageVersion(var_.listing_package_package_version())
                .compartmentId(var_.compartment_id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_listing_package = oci.Marketplace.get_listing_package(listing_id=oci_marketplace_listing["test_listing"]["id"],
        package_version=var["listing_package_package_version"],
        compartment_id=var["compartment_id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testListingPackage = oci.Marketplace.getListingPackage({
        listingId: oci_marketplace_listing.test_listing.id,
        packageVersion: _var.listing_package_package_version,
        compartmentId: _var.compartment_id,
    });
    
    variables:
      testListingPackage:
        fn::invoke:
          Function: oci:Marketplace:getListingPackage
          Arguments:
            listingId: ${oci_marketplace_listing.test_listing.id}
            packageVersion: ${var.listing_package_package_version}
            compartmentId: ${var.compartment_id}
    

    Using getListingPackage

    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 getListingPackage(args: GetListingPackageArgs, opts?: InvokeOptions): Promise<GetListingPackageResult>
    function getListingPackageOutput(args: GetListingPackageOutputArgs, opts?: InvokeOptions): Output<GetListingPackageResult>
    def get_listing_package(compartment_id: Optional[str] = None,
                            listing_id: Optional[str] = None,
                            package_version: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetListingPackageResult
    def get_listing_package_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            listing_id: Optional[pulumi.Input[str]] = None,
                            package_version: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetListingPackageResult]
    func GetListingPackage(ctx *Context, args *GetListingPackageArgs, opts ...InvokeOption) (*GetListingPackageResult, error)
    func GetListingPackageOutput(ctx *Context, args *GetListingPackageOutputArgs, opts ...InvokeOption) GetListingPackageResultOutput

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

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

    The following arguments are supported:

    ListingId string
    The unique identifier for the listing.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    CompartmentId string
    The unique identifier for the compartment.
    ListingId string
    The unique identifier for the listing.
    PackageVersion string
    The version of the package. Package versions are unique within a listing.
    CompartmentId string
    The unique identifier for the compartment.
    listingId String
    The unique identifier for the listing.
    packageVersion String
    The version of the package. Package versions are unique within a listing.
    compartmentId String
    The unique identifier for the compartment.
    listingId string
    The unique identifier for the listing.
    packageVersion string
    The version of the package. Package versions are unique within a listing.
    compartmentId string
    The unique identifier for the compartment.
    listing_id str
    The unique identifier for the listing.
    package_version str
    The version of the package. Package versions are unique within a listing.
    compartment_id str
    The unique identifier for the compartment.
    listingId String
    The unique identifier for the listing.
    packageVersion String
    The version of the package. Package versions are unique within a listing.
    compartmentId String
    The unique identifier for the compartment.

    getListingPackage Result

    The following output properties are available:

    AppCatalogListingId string
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    AppCatalogListingResourceVersion string
    The resource version of the listing resource associated with this listing package.
    Description string
    A description of the variable.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The ID of the image corresponding to the package.
    ListingId string
    The ID of the listing that the specified package belongs to.
    OperatingSystems List<GetListingPackageOperatingSystem>
    The operating system used by the listing.
    PackageType string
    The specified package's type.
    PackageVersion string
    Pricings List<GetListingPackagePricing>
    The model for pricing.
    Regions List<GetListingPackageRegion>
    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.
    ResourceLink string
    Link to the orchestration 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
    Variables List<GetListingPackageVariable>
    List of variables for the orchestration resource.
    Version string
    The package version.
    CompartmentId string
    AppCatalogListingId string
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    AppCatalogListingResourceVersion string
    The resource version of the listing resource associated with this listing package.
    Description string
    A description of the variable.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The ID of the image corresponding to the package.
    ListingId string
    The ID of the listing that the specified package belongs to.
    OperatingSystems []GetListingPackageOperatingSystem
    The operating system used by the listing.
    PackageType string
    The specified package's type.
    PackageVersion string
    Pricings []GetListingPackagePricing
    The model for pricing.
    Regions []GetListingPackageRegion
    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.
    ResourceLink string
    Link to the orchestration 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
    Variables []GetListingPackageVariable
    List of variables for the orchestration resource.
    Version string
    The package version.
    CompartmentId string
    appCatalogListingId String
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    appCatalogListingResourceVersion String
    The resource version of the listing resource associated with this listing package.
    description String
    A description of the variable.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The ID of the image corresponding to the package.
    listingId String
    The ID of the listing that the specified package belongs to.
    operatingSystems List<GetListingPackageOperatingSystem>
    The operating system used by the listing.
    packageType String
    The specified package's type.
    packageVersion String
    pricings List<GetListingPackagePricing>
    The model for pricing.
    regions List<GetListingPackageRegion>
    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.
    resourceLink String
    Link to the orchestration 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
    variables List<GetListingPackageVariable>
    List of variables for the orchestration resource.
    version String
    The package version.
    compartmentId String
    appCatalogListingId string
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    appCatalogListingResourceVersion string
    The resource version of the listing resource associated with this listing package.
    description string
    A description of the variable.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    The ID of the image corresponding to the package.
    listingId string
    The ID of the listing that the specified package belongs to.
    operatingSystems GetListingPackageOperatingSystem[]
    The operating system used by the listing.
    packageType string
    The specified package's type.
    packageVersion string
    pricings GetListingPackagePricing[]
    The model for pricing.
    regions GetListingPackageRegion[]
    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.
    resourceLink string
    Link to the orchestration 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
    variables GetListingPackageVariable[]
    List of variables for the orchestration resource.
    version string
    The package version.
    compartmentId string
    app_catalog_listing_id str
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    app_catalog_listing_resource_version str
    The resource version of the listing resource associated with this listing package.
    description str
    A description of the variable.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    The ID of the image corresponding to the package.
    listing_id str
    The ID of the listing that the specified package belongs to.
    operating_systems GetListingPackageOperatingSystem]
    The operating system used by the listing.
    package_type str
    The specified package's type.
    package_version str
    pricings GetListingPackagePricing]
    The model for pricing.
    regions GetListingPackageRegion]
    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.
    resource_link str
    Link to the orchestration 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
    variables GetListingPackageVariable]
    List of variables for the orchestration resource.
    version str
    The package version.
    compartment_id str
    appCatalogListingId String
    The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
    appCatalogListingResourceVersion String
    The resource version of the listing resource associated with this listing package.
    description String
    A description of the variable.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The ID of the image corresponding to the package.
    listingId String
    The ID of the listing that the specified package belongs to.
    operatingSystems List<Property Map>
    The operating system used by the listing.
    packageType String
    The specified package's type.
    packageVersion String
    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.
    resourceLink String
    Link to the orchestration 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
    variables List<Property Map>
    List of variables for the orchestration resource.
    version String
    The package version.
    compartmentId String

    Supporting Types

    GetListingPackageOperatingSystem

    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.

    GetListingPackagePricing

    Currency string
    The currency of the pricing model.
    InternationalMarketPrices List<GetListingPackagePricingInternationalMarketPrice>
    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 []GetListingPackagePricingInternationalMarketPrice
    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<GetListingPackagePricingInternationalMarketPrice>
    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 GetListingPackagePricingInternationalMarketPrice[]
    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 GetListingPackagePricingInternationalMarketPrice]
    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.

    GetListingPackagePricingInternationalMarketPrice

    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.

    GetListingPackageRegion

    Code string
    A code assigned to the item.
    Countries List<GetListingPackageRegionCountry>
    Countries in the region.
    Name string
    The name of the variable.
    Code string
    A code assigned to the item.
    Countries []GetListingPackageRegionCountry
    Countries in the region.
    Name string
    The name of the variable.
    code String
    A code assigned to the item.
    countries List<GetListingPackageRegionCountry>
    Countries in the region.
    name String
    The name of the variable.
    code string
    A code assigned to the item.
    countries GetListingPackageRegionCountry[]
    Countries in the region.
    name string
    The name of the variable.
    code str
    A code assigned to the item.
    countries GetListingPackageRegionCountry]
    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.

    GetListingPackageRegionCountry

    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.

    GetListingPackageVariable

    DataType string
    The data type of the variable.
    DefaultValue string
    The variable's default value.
    Description string
    A description of the variable.
    HintMessage string
    A brief textual description that helps to explain the variable.
    IsMandatory bool
    Whether the variable is mandatory.
    Name string
    The name of the variable.
    DataType string
    The data type of the variable.
    DefaultValue string
    The variable's default value.
    Description string
    A description of the variable.
    HintMessage string
    A brief textual description that helps to explain the variable.
    IsMandatory bool
    Whether the variable is mandatory.
    Name string
    The name of the variable.
    dataType String
    The data type of the variable.
    defaultValue String
    The variable's default value.
    description String
    A description of the variable.
    hintMessage String
    A brief textual description that helps to explain the variable.
    isMandatory Boolean
    Whether the variable is mandatory.
    name String
    The name of the variable.
    dataType string
    The data type of the variable.
    defaultValue string
    The variable's default value.
    description string
    A description of the variable.
    hintMessage string
    A brief textual description that helps to explain the variable.
    isMandatory boolean
    Whether the variable is mandatory.
    name string
    The name of the variable.
    data_type str
    The data type of the variable.
    default_value str
    The variable's default value.
    description str
    A description of the variable.
    hint_message str
    A brief textual description that helps to explain the variable.
    is_mandatory bool
    Whether the variable is mandatory.
    name str
    The name of the variable.
    dataType String
    The data type of the variable.
    defaultValue String
    The variable's default value.
    description String
    A description of the variable.
    hintMessage String
    A brief textual description that helps to explain the variable.
    isMandatory Boolean
    Whether the variable is mandatory.
    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.24.0 published on Thursday, Feb 22, 2024 by Pulumi