Api Product

Service:: API Management

API Version:: 2017-03-01

Lists all Products, which the API is part of.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products&api-version={api-version}

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products?$filter={$filter}&$top={$top}&$skip={$skip}&api-version={api-version}

URI Parameters

Name In Required Type Description

operationId

path

True

string

Operation identifier within an API. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$

policyId

path

True

string

The identifier of the Policy.

subscriptionId

path

True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName

path

True

string

The name of the resource group.

serviceName

path

True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

apiId

path

True

string

API identifier. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$

$filter

query

string

Field	Supported operators	Supported functions
name	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith

$top

query

integer
int32

Number of records to return.

$skip

query

integer
int32

Number of records to skip.

api-version

query

True

string

Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	ProductCollection	The operation returns a collection of products which have the Api entity.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ApiManagementGetProductsForApi

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/products&api-version=2017-03-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002",
      "type": "Microsoft.ApiManagement/service/apis/products",
      "name": "5600b539c53f5b0062060002",
      "properties": {
        "displayName": "Unlimited",
        "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
        "subscriptionRequired": true,
        "approvalRequired": true,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    }
  ],
  "nextLink": ""
}

Definitions

ErrorFieldContract	Error Field contract.
ErrorResponse
ProductCollection
ProductContract	Product details.

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Name	Type	Description
code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
message	string	Human-readable representation of the error.

ProductCollection

Name	Type	Description
nextLink	string	Next page link if any.
value	ProductContract[]	Page values.

ProductContract

Product details.

Name	Type	Description
approvalRequired	boolean	whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
description	string	Product description. May include HTML formatting tags.
displayName	string	Product name.
id	string	Resource ID.
name	string	Resource name.
state	enum: notPublished published	whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
subscriptionRequired	boolean	Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
subscriptionsLimit	integer int32	Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
terms	string	Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
type	string	Resource type for API Management resource.