Azure v6.21.0, Mar 7 25

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.apimanagement.getProduct

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

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

const example = azure.apimanagement.getProduct({
    productId: "my-product",
    apiManagementName: "example-apim",
    resourceGroupName: "search-service",
});
export const productTerms = example.then(example => example.terms);

import pulumi
import pulumi_azure as azure

example = azure.apimanagement.get_product(product_id="my-product",
    api_management_name="example-apim",
    resource_group_name="search-service")
pulumi.export("productTerms", example.terms)

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := apimanagement.LookupProduct(ctx, &apimanagement.LookupProductArgs{
			ProductId:         "my-product",
			ApiManagementName: "example-apim",
			ResourceGroupName: "search-service",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("productTerms", example.Terms)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ApiManagement.GetProduct.Invoke(new()
    {
        ProductId = "my-product",
        ApiManagementName = "example-apim",
        ResourceGroupName = "search-service",
    });

    return new Dictionary<string, object?>
    {
        ["productTerms"] = example.Apply(getProductResult => getProductResult.Terms),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetProductArgs;
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 example = ApimanagementFunctions.getProduct(GetProductArgs.builder()
            .productId("my-product")
            .apiManagementName("example-apim")
            .resourceGroupName("search-service")
            .build());

        ctx.export("productTerms", example.applyValue(getProductResult -> getProductResult.terms()));
    }
}

variables:
  example:
    fn::invoke:
      function: azure:apimanagement:getProduct
      arguments:
        productId: my-product
        apiManagementName: example-apim
        resourceGroupName: search-service
outputs:
  productTerms: ${example.terms}

Using getProduct

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 getProduct(args: GetProductArgs, opts?: InvokeOptions): Promise<GetProductResult>
function getProductOutput(args: GetProductOutputArgs, opts?: InvokeOptions): Output<GetProductResult>

def get_product(api_management_name: Optional[str] = None,
                product_id: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProductResult
def get_product_output(api_management_name: Optional[pulumi.Input[str]] = None,
                product_id: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProductResult]

func LookupProduct(ctx *Context, args *LookupProductArgs, opts ...InvokeOption) (*LookupProductResult, error)
func LookupProductOutput(ctx *Context, args *LookupProductOutputArgs, opts ...InvokeOption) LookupProductResultOutput

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

public static class GetProduct 
{
    public static Task<GetProductResult> InvokeAsync(GetProductArgs args, InvokeOptions? opts = null)
    public static Output<GetProductResult> Invoke(GetProductInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProductResult> getProduct(GetProductArgs args, InvokeOptions options)
public static Output<GetProductResult> getProduct(GetProductArgs args, InvokeOptions options)

fn::invoke:
  function: azure:apimanagement/getProduct:getProduct
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiManagementName string: The Name of the API Management Service in which this Product exists.
ProductId string: The Identifier for the API Management Product.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

ApiManagementName string: The Name of the API Management Service in which this Product exists.
ProductId string: The Identifier for the API Management Product.
ResourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

apiManagementName String: The Name of the API Management Service in which this Product exists.
productId String: The Identifier for the API Management Product.
resourceGroupName String: The Name of the Resource Group in which the API Management Service exists.

apiManagementName string: The Name of the API Management Service in which this Product exists.
productId string: The Identifier for the API Management Product.
resourceGroupName string: The Name of the Resource Group in which the API Management Service exists.

api_management_name str: The Name of the API Management Service in which this Product exists.
product_id str: The Identifier for the API Management Product.
resource_group_name str: The Name of the Resource Group in which the API Management Service exists.

apiManagementName String: The Name of the API Management Service in which this Product exists.
productId String: The Identifier for the API Management Product.
resourceGroupName String: The Name of the Resource Group in which the API Management Service exists.

getProduct Result

The following output properties are available:

ApiManagementName string
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: The description of this Product, which may include HTML formatting tags.
DisplayName string: The Display Name for this API Management Product.
Id string: The provider-assigned unique ID for this managed resource.
ProductId string
Published bool: Is this Product Published?
ResourceGroupName string
SubscriptionRequired bool: Is a Subscription required to access API's included in this Product?
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

ApiManagementName string
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: The description of this Product, which may include HTML formatting tags.
DisplayName string: The Display Name for this API Management Product.
Id string: The provider-assigned unique ID for this managed resource.
ProductId string
Published bool: Is this Product Published?
ResourceGroupName string
SubscriptionRequired bool: Is a Subscription required to access API's included in this Product?
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

apiManagementName String
approvalRequired Boolean: Do subscribers need to be approved prior to being able to use the Product?
description String: The description of this Product, which may include HTML formatting tags.
displayName String: The Display Name for this API Management Product.
id String: The provider-assigned unique ID for this managed resource.
productId String
published Boolean: Is this Product Published?
resourceGroupName String
subscriptionRequired Boolean: Is a Subscription required to access API's included in this Product?
subscriptionsLimit Integer: The number of subscriptions a user can have to this Product at the same time.
terms String: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

apiManagementName string
approvalRequired boolean: Do subscribers need to be approved prior to being able to use the Product?
description string: The description of this Product, which may include HTML formatting tags.
displayName string: The Display Name for this API Management Product.
id string: The provider-assigned unique ID for this managed resource.
productId string
published boolean: Is this Product Published?
resourceGroupName string
subscriptionRequired boolean: Is a Subscription required to access API's included in this Product?
subscriptionsLimit number: The number of subscriptions a user can have to this Product at the same time.
terms string: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

api_management_name str
approval_required bool: Do subscribers need to be approved prior to being able to use the Product?
description str: The description of this Product, which may include HTML formatting tags.
display_name str: The Display Name for this API Management Product.
id str: The provider-assigned unique ID for this managed resource.
product_id str
published bool: Is this Product Published?
resource_group_name str
subscription_required bool: Is a Subscription required to access API's included in this Product?
subscriptions_limit int: The number of subscriptions a user can have to this Product at the same time.
terms str: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

apiManagementName String
approvalRequired Boolean: Do subscribers need to be approved prior to being able to use the Product?
description String: The description of this Product, which may include HTML formatting tags.
displayName String: The Display Name for this API Management Product.
id String: The provider-assigned unique ID for this managed resource.
productId String
published Boolean: Is this Product Published?
resourceGroupName String
subscriptionRequired Boolean: Is a Subscription required to access API's included in this Product?
subscriptionsLimit Number: The number of subscriptions a user can have to this Product at the same time.
terms String: Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.apimanagement.getProduct

On this page

On this page

Example Usage

Using getProduct

getProduct Result

Package Details

On this page

On this page