Microsoft.ApiManagement service/subscriptions template reference

Template format

To create a Microsoft.ApiManagement/service/subscriptions resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2019-01-01",
  "properties": {
    "ownerId": "string",
    "scope": "string",
    "displayName": "string",
    "primaryKey": "string",
    "secondaryKey": "string",
    "state": "string",
    "allowTracing": "boolean"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/subscriptions object

Name Type Required Value
name string Yes Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
type enum Yes subscriptions

See Set name and type for child resources.
apiVersion enum Yes 2019-01-01
properties object Yes Subscription contract properties. - SubscriptionCreateParameterProperties object

SubscriptionCreateParameterProperties object

Name Type Required Value
ownerId string No User (user id path) for whom subscription is being created in form /users/{userId}
scope string Yes Scope like /products/{productId} or /apis or /apis/{apiId}.
displayName string Yes Subscription name.
primaryKey string No Primary subscription key. If not specified during request key will be generated automatically.
secondaryKey string No Secondary subscription key. If not specified during request key will be generated automatically.
state enum No Initial subscription state. If no value is specified, subscription is created with Submitted 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. - suspended, active, expired, submitted, rejected, cancelled
allowTracing boolean No Determines whether tracing can be enabled

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities