Tutorial: Create and publish a product

In Azure API Management, a product contains one or more APIs as well as a usage quota and the terms of use. Once a product is published, developers can subscribe to the product and begin to use the product's APIs.

In this tutorial, you learn how to:

  • Create and publish a product
  • Add an API to the product

API Management products in portal

Prerequisites

Create and publish a product

  1. Sign in to the Azure portal, and navigate to your API Management instance.

  2. In the left navigation, select Products > + Add.

  3. In the Add product window, enter values described in the following table to create your product.

    Add product in portal

    Name Description
    Display name The name as you want it to be shown in the developer portal.
    Description Provide information about the product such as its purpose, the APIs it provides access to, and other details.
    State Select Published if you want to publish the product. Before the APIs in a product can be called, the product must be published. By default, new products are unpublished, and are visible only to the Administrators group.
    Requires subscription Select if a user is required to subscribe to use the product.
    Requires approval Select if you want an administrator to review and accept or reject subscription attempts to this product. If not selected, subscription attempts are auto-approved.
    Subscription count limit Optionally limit the count of multiple simultaneous subscriptions.
    Legal terms You can include the terms of use for the product which subscribers must accept in order to use the product.
    APIs Select one or more APIs. You can also add APIs after creating the product. For more information, see Add APIs to a product later in this article.
  4. Select Create to create the new product.

Add more configurations

Continue configuring the product after saving it. In your API Management instance, select the product from the Products window. Add or update:

Item Description
Settings Product metadata and state
APIs APIs associated with the product
Policies Policies applied to product APIs
Access control Product visibility for developers or guests
Subscriptions Product subscribers

Add APIs to a product

Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. During the product creation, you can add one or more existing APIs. You can also add APIs to the product later, either from the Products Settings page or while creating an API.

Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the APIM instance, you are an administrator already, so you are subscribed to every product by default.

Add an API to an existing product

  1. In the left navigation of your API Management instance, select Products.
  2. Select a product, then select APIs.
  3. Select + Add.
  4. Select one or more APIs and then Select.

Add API to existing product

Tip

You can create or update a user's subscription to a product with custom subscription keys through a REST API or PowerShell command.

Next steps

In this tutorial, you learned how to:

  • Create and publish a product
  • Add an API to the product

Advance to the next tutorial: