oci.Marketplace.getListingPackage
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testListingPackage = oci.Marketplace.getListingPackage({
    listingId: testListing.id,
    packageVersion: listingPackagePackageVersion,
    compartmentId: compartmentId,
});
import pulumi
import pulumi_oci as oci
test_listing_package = oci.Marketplace.get_listing_package(listing_id=test_listing["id"],
    package_version=listing_package_package_version,
    compartment_id=compartment_id)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/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:      testListing.Id,
			PackageVersion: listingPackagePackageVersion,
			CompartmentId:  pulumi.StringRef(compartmentId),
		}, 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 testListingPackage = Oci.Marketplace.GetListingPackage.Invoke(new()
    {
        ListingId = testListing.Id,
        PackageVersion = listingPackagePackageVersion,
        CompartmentId = compartmentId,
    });
});
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(testListing.id())
            .packageVersion(listingPackagePackageVersion)
            .compartmentId(compartmentId)
            .build());
    }
}
variables:
  testListingPackage:
    fn::invoke:
      function: oci:Marketplace:getListingPackage
      arguments:
        listingId: ${testListing.id}
        packageVersion: ${listingPackagePackageVersion}
        compartmentId: ${compartmentId}
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)
public static Output<GetListingPackageResult> getListingPackage(GetListingPackageArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Marketplace/getListingPackage:getListingPackage
  arguments:
    # arguments dictionaryThe 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:
- AppCatalog stringListing Id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- AppCatalog stringListing Resource Version 
- 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<GetListing Package Operating System> 
- The operating system used by the listing.
- PackageType string
- The specified package's type.
- PackageVersion string
- Pricings
List<GetListing Package Pricing> 
- The model for pricing.
- Regions
List<GetListing Package Region> 
- 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<GetListing Package Variable> 
- List of variables for the orchestration resource.
- Version string
- The package version.
- CompartmentId string
- AppCatalog stringListing Id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- AppCatalog stringListing Resource Version 
- 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 []GetListing Package Operating System 
- The operating system used by the listing.
- PackageType string
- The specified package's type.
- PackageVersion string
- Pricings
[]GetListing Package Pricing 
- The model for pricing.
- Regions
[]GetListing Package Region 
- 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
[]GetListing Package Variable 
- List of variables for the orchestration resource.
- Version string
- The package version.
- CompartmentId string
- appCatalog StringListing Id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- appCatalog StringListing Resource Version 
- 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<GetListing Package Operating System> 
- The operating system used by the listing.
- packageType String
- The specified package's type.
- packageVersion String
- pricings
List<GetListing Package Pricing> 
- The model for pricing.
- regions
List<GetListing Package Region> 
- 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<GetListing Package Variable> 
- List of variables for the orchestration resource.
- version String
- The package version.
- compartmentId String
- appCatalog stringListing Id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- appCatalog stringListing Resource Version 
- 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 GetListing Package Operating System[] 
- The operating system used by the listing.
- packageType string
- The specified package's type.
- packageVersion string
- pricings
GetListing Package Pricing[] 
- The model for pricing.
- regions
GetListing Package Region[] 
- 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
GetListing Package Variable[] 
- List of variables for the orchestration resource.
- version string
- The package version.
- compartmentId string
- app_catalog_ strlisting_ id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- app_catalog_ strlisting_ resource_ version 
- 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 Sequence[GetListing Package Operating System] 
- The operating system used by the listing.
- package_type str
- The specified package's type.
- package_version str
- pricings
Sequence[GetListing Package Pricing] 
- The model for pricing.
- regions
Sequence[GetListing Package Region] 
- 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
Sequence[GetListing Package Variable] 
- List of variables for the orchestration resource.
- version str
- The package version.
- compartment_id str
- appCatalog StringListing Id 
- The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
- appCatalog StringListing Resource Version 
- 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.
- InternationalMarket List<GetPrices Listing Package Pricing International Market Price> 
- The model for international market pricing.
- PayGo stringStrategy 
- 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.
- InternationalMarket []GetPrices Listing Package Pricing International Market Price 
- The model for international market pricing.
- PayGo stringStrategy 
- 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.
- internationalMarket List<GetPrices Listing Package Pricing International Market Price> 
- The model for international market pricing.
- payGo StringStrategy 
- 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.
- internationalMarket GetPrices Listing Package Pricing International Market Price[] 
- The model for international market pricing.
- payGo stringStrategy 
- 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_ Sequence[Getprices Listing Package Pricing International Market Price] 
- The model for international market pricing.
- pay_go_ strstrategy 
- 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.
- internationalMarket List<Property Map>Prices 
- The model for international market pricing.
- payGo StringStrategy 
- 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<GetListing Package Region Country> 
- Countries in the region.
- Name string
- The name of the variable.
- Code string
- A code assigned to the item.
- Countries
[]GetListing Package Region Country 
- Countries in the region.
- Name string
- The name of the variable.
- code String
- A code assigned to the item.
- countries
List<GetListing Package Region Country> 
- Countries in the region.
- name String
- The name of the variable.
- code string
- A code assigned to the item.
- countries
GetListing Package Region Country[] 
- Countries in the region.
- name string
- The name of the variable.
- code str
- A code assigned to the item.
- countries
Sequence[GetListing Package Region Country] 
- 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    
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 ociTerraform Provider.