alicloud.marketplace.getProducts

Explore with Pulumi AI

Alibaba Cloud v3.82.0 published on Tuesday, Jul 8, 2025 by Pulumi

Using getProducts

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 getProducts(args: GetProductsArgs, opts?: InvokeOptions): Promise<GetProductsResult>
function getProductsOutput(args: GetProductsOutputArgs, opts?: InvokeOptions): Output<GetProductsResult>

def get_products(category_id: Optional[str] = None,
                 ids: Optional[Sequence[str]] = None,
                 name_regex: Optional[str] = None,
                 output_file: Optional[str] = None,
                 product_type: Optional[str] = None,
                 search_term: Optional[str] = None,
                 sort: Optional[str] = None,
                 suggested_price: Optional[float] = None,
                 supplier_id: Optional[str] = None,
                 supplier_name_keyword: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetProductsResult
def get_products_output(category_id: Optional[pulumi.Input[str]] = None,
                 ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 product_type: Optional[pulumi.Input[str]] = None,
                 search_term: Optional[pulumi.Input[str]] = None,
                 sort: Optional[pulumi.Input[str]] = None,
                 suggested_price: Optional[pulumi.Input[float]] = None,
                 supplier_id: Optional[pulumi.Input[str]] = None,
                 supplier_name_keyword: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetProductsResult]

func GetProducts(ctx *Context, args *GetProductsArgs, opts ...InvokeOption) (*GetProductsResult, error)
func GetProductsOutput(ctx *Context, args *GetProductsOutputArgs, opts ...InvokeOption) GetProductsResultOutput

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

public static class GetProducts 
{
    public static Task<GetProductsResult> InvokeAsync(GetProductsArgs args, InvokeOptions? opts = null)
    public static Output<GetProductsResult> Invoke(GetProductsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProductsResult> getProducts(GetProductsArgs args, InvokeOptions options)
public static Output<GetProductsResult> getProducts(GetProductsArgs args, InvokeOptions options)

fn::invoke:
  function: alicloud:marketplace/getProducts:getProducts
  arguments:
    # arguments dictionary

The following arguments are supported:

CategoryId string: The Category ID of products.
Ids List<string>: A list of product code.
NameRegex string: A regex string to apply to the product name.
OutputFile string: File name where to save data source results (after running pulumi preview).
ProductType string: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
SearchTerm string: Search term in this query.
Sort string: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
SuggestedPrice double: The suggested price of the product.
SupplierId string: The supplier id of the product.
SupplierNameKeyword string: The supplier name keyword of the product.

CategoryId string: The Category ID of products.
Ids []string: A list of product code.
NameRegex string: A regex string to apply to the product name.
OutputFile string: File name where to save data source results (after running pulumi preview).
ProductType string: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
SearchTerm string: Search term in this query.
Sort string: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
SuggestedPrice float64: The suggested price of the product.
SupplierId string: The supplier id of the product.
SupplierNameKeyword string: The supplier name keyword of the product.

categoryId String: The Category ID of products.
ids List<String>: A list of product code.
nameRegex String: A regex string to apply to the product name.
outputFile String: File name where to save data source results (after running pulumi preview).
productType String: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
searchTerm String: Search term in this query.
sort String: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
suggestedPrice Double: The suggested price of the product.
supplierId String: The supplier id of the product.
supplierNameKeyword String: The supplier name keyword of the product.

categoryId string: The Category ID of products.
ids string[]: A list of product code.
nameRegex string: A regex string to apply to the product name.
outputFile string: File name where to save data source results (after running pulumi preview).
productType string: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
searchTerm string: Search term in this query.
sort string: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
suggestedPrice number: The suggested price of the product.
supplierId string: The supplier id of the product.
supplierNameKeyword string: The supplier name keyword of the product.

category_id str: The Category ID of products.
ids Sequence[str]: A list of product code.
name_regex str: A regex string to apply to the product name.
output_file str: File name where to save data source results (after running pulumi preview).
product_type str: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
search_term str: Search term in this query.
sort str: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
suggested_price float: The suggested price of the product.
supplier_id str: The supplier id of the product.
supplier_name_keyword str: The supplier name keyword of the product.

categoryId String: The Category ID of products.
ids List<String>: A list of product code.
nameRegex String: A regex string to apply to the product name.
outputFile String: File name where to save data source results (after running pulumi preview).
productType String: The type of products, Valid values: APP, SERVICE, MIRROR, DOWNLOAD and API_SERVICE.
searchTerm String: Search term in this query.
sort String: This field determines how to sort the filtered results, Valid values: user_count-desc, created_on-desc, price-desc and score-desc.
suggestedPrice Number: The suggested price of the product.
supplierId String: The supplier id of the product.
supplierNameKeyword String: The supplier name keyword of the product.

getProducts Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of product codes.
Products List<Pulumi.AliCloud.MarketPlace.Outputs.GetProductsProduct>: A list of products. Each element contains the following attributes:
CategoryId string: The category id of the product.
NameRegex string
OutputFile string
ProductType string
SearchTerm string
Sort string
SuggestedPrice double: The suggested price of the product.
SupplierId string: The supplier id of the product.
SupplierNameKeyword string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of product codes.
Products []GetProductsProduct: A list of products. Each element contains the following attributes:
CategoryId string: The category id of the product.
NameRegex string
OutputFile string
ProductType string
SearchTerm string
Sort string
SuggestedPrice float64: The suggested price of the product.
SupplierId string: The supplier id of the product.
SupplierNameKeyword string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of product codes.
products List<GetProductsProduct>: A list of products. Each element contains the following attributes:
categoryId String: The category id of the product.
nameRegex String
outputFile String
productType String
searchTerm String
sort String
suggestedPrice Double: The suggested price of the product.
supplierId String: The supplier id of the product.
supplierNameKeyword String

id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of product codes.
products GetProductsProduct[]: A list of products. Each element contains the following attributes:
categoryId string: The category id of the product.
nameRegex string
outputFile string
productType string
searchTerm string
sort string
suggestedPrice number: The suggested price of the product.
supplierId string: The supplier id of the product.
supplierNameKeyword string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: A list of product codes.
products Sequence[GetProductsProduct]: A list of products. Each element contains the following attributes:
category_id str: The category id of the product.
name_regex str
output_file str
product_type str
search_term str
sort str
suggested_price float: The suggested price of the product.
supplier_id str: The supplier id of the product.
supplier_name_keyword str

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of product codes.
products List<Property Map>: A list of products. Each element contains the following attributes:
categoryId String: The category id of the product.
nameRegex String
outputFile String
productType String
searchTerm String
sort String
suggestedPrice Number: The suggested price of the product.
supplierId String: The supplier id of the product.
supplierNameKeyword String

Supporting Types

GetProductsProduct

CategoryId int: The Category ID of products.
Code string: The code of the product.
DeliveryDate string: The delivery date of the product.
DeliveryWay string: The delivery way of the product.
ImageUrl string: The image URL of the product.
Name string: The name of the product.
OperationSystem string: The operation system of the product.
Score string: The rating information of the product.
ShortDescription string: The short description of the product.
SuggestedPrice string: The suggested price of the product.
SupplierId int: The supplier id of the product.
SupplierName string: The supplier name of the product.
Tags string: The tags of the product.
TargetUrl string: The detail page URL of the product.
WarrantyDate string: The warranty date of the product.

CategoryId int: The Category ID of products.
Code string: The code of the product.
DeliveryDate string: The delivery date of the product.
DeliveryWay string: The delivery way of the product.
ImageUrl string: The image URL of the product.
Name string: The name of the product.
OperationSystem string: The operation system of the product.
Score string: The rating information of the product.
ShortDescription string: The short description of the product.
SuggestedPrice string: The suggested price of the product.
SupplierId int: The supplier id of the product.
SupplierName string: The supplier name of the product.
Tags string: The tags of the product.
TargetUrl string: The detail page URL of the product.
WarrantyDate string: The warranty date of the product.

categoryId Integer: The Category ID of products.
code String: The code of the product.
deliveryDate String: The delivery date of the product.
deliveryWay String: The delivery way of the product.
imageUrl String: The image URL of the product.
name String: The name of the product.
operationSystem String: The operation system of the product.
score String: The rating information of the product.
shortDescription String: The short description of the product.
suggestedPrice String: The suggested price of the product.
supplierId Integer: The supplier id of the product.
supplierName String: The supplier name of the product.
tags String: The tags of the product.
targetUrl String: The detail page URL of the product.
warrantyDate String: The warranty date of the product.

categoryId number: The Category ID of products.
code string: The code of the product.
deliveryDate string: The delivery date of the product.
deliveryWay string: The delivery way of the product.
imageUrl string: The image URL of the product.
name string: The name of the product.
operationSystem string: The operation system of the product.
score string: The rating information of the product.
shortDescription string: The short description of the product.
suggestedPrice string: The suggested price of the product.
supplierId number: The supplier id of the product.
supplierName string: The supplier name of the product.
tags string: The tags of the product.
targetUrl string: The detail page URL of the product.
warrantyDate string: The warranty date of the product.

category_id int: The Category ID of products.
code str: The code of the product.
delivery_date str: The delivery date of the product.
delivery_way str: The delivery way of the product.
image_url str: The image URL of the product.
name str: The name of the product.
operation_system str: The operation system of the product.
score str: The rating information of the product.
short_description str: The short description of the product.
suggested_price str: The suggested price of the product.
supplier_id int: The supplier id of the product.
supplier_name str: The supplier name of the product.
tags str: The tags of the product.
target_url str: The detail page URL of the product.
warranty_date str: The warranty date of the product.

categoryId Number: The Category ID of products.
code String: The code of the product.
deliveryDate String: The delivery date of the product.
deliveryWay String: The delivery way of the product.
imageUrl String: The image URL of the product.
name String: The name of the product.
operationSystem String: The operation system of the product.
score String: The rating information of the product.
shortDescription String: The short description of the product.
suggestedPrice String: The suggested price of the product.
supplierId Number: The supplier id of the product.
supplierName String: The supplier name of the product.
tags String: The tags of the product.
targetUrl String: The detail page URL of the product.
warrantyDate String: The warranty date of the product.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.82.0 published on Tuesday, Jul 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.marketplace.getProducts

On this page

On this page

Using getProducts

getProducts Result

Supporting Types

GetProductsProduct

Package Details

On this page

On this page