Product Subscriptions

Service:: API Management

API Version:: 2017-03-01

Lists the collection of subscriptions to the specified product.

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

With optional parameters:

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

URI Parameters

Name In Required Type Description

policyId

path

True

string

The identifier of the Policy.

groupId

path

True

string

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

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

apiId

path

True

string

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

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

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])?$

productId

path

True

string

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

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

$filter

query

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
name	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
stateComment	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
userId	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
productId	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
state	eq

$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	SubscriptionCollection	Lists a collection of subscription entities.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ApiManagementListProductSubscriptions

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/592f117198a5ce0c64de1a62",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "592f117198a5ce0c64de1a62",
      "properties": {
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4",
        "displayName": " ARM Template ProductName 4 subscription",
        "state": "active",
        "createdDate": "2017-05-31T18:54:41.133Z",
        "startDate": "2017-05-31T00:00:00.000Z",
        "primaryKey": "9c79c5e0ad2d49b385a295bda544c3ad",
        "secondaryKey": "9fcdada8f46e4de7afa2158c19cce7b5"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/armTemplatesubscription2",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "armTemplatesubscription2",
      "properties": {
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/armTemplateUser3",
        "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4",
        "displayName": " ARM Template ProductName 4 subscription",
        "state": "active",
        "createdDate": "2017-05-31T18:54:50.920Z",
        "startDate": "2017-05-31T00:00:00.000Z",
        "primaryKey": "6a4ba8a67f2b4db48031c56320bfa035",
        "secondaryKey": "9da2585b029b46e18607f4a08bf66f5e"
      }
    }
  ],
  "nextLink": ""
}

Definitions

ErrorFieldContract	Error Field contract.
ErrorResponse
SubscriptionCollection
SubscriptionContract	Subscription 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.

SubscriptionCollection

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

SubscriptionContract

Subscription details.

Name	Type	Description
createdDate	string date-time	Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
displayName	string	The name of the subscription, or null if the subscription has no name.
endDate	string date-time	Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
expirationDate	string date-time	Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
id	string	Resource ID.
name	string	Resource name.
notificationDate	string date-time	Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
primaryKey	string	Subscription primary key.
productId	string	The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
secondaryKey	string	Subscription secondary key.
startDate	string date-time	Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
state	enum: suspended active expired submitted rejected cancelled	Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.
stateComment	string	Optional subscription comment added by an administrator.
type	string	Resource type for API Management resource.
userId	string	The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier.