Microsoft.ApiManagement service/subscriptions

Bicep resource definition

The service/subscriptions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/subscriptions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Property values

service/subscriptions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: service
properties Subscription contract properties. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name Description Value
allowTracing Determines whether tracing can be enabled bool
displayName Subscription name. string (required)

Constraints:
Min length = 1
Max length = 100
ownerId User (user id path) for whom subscription is being created in form /users/{userId} string
primaryKey Primary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
scope Scope like /products/{productId} or /apis or /apis/{apiId}. string (required)
secondaryKey Secondary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
state 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. 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

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

ARM template resource definition

The service/subscriptions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Property values

service/subscriptions

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/subscriptions'
apiVersion The resource api version '2023-09-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
properties Subscription contract properties. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name Description Value
allowTracing Determines whether tracing can be enabled bool
displayName Subscription name. string (required)

Constraints:
Min length = 1
Max length = 100
ownerId User (user id path) for whom subscription is being created in form /users/{userId} string
primaryKey Primary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
scope Scope like /products/{productId} or /apis or /apis/{apiId}. string (required)
secondaryKey Secondary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
state 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. 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

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

Terraform (AzAPI provider) resource definition

The service/subscriptions resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/subscriptions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Property values

service/subscriptions

Name Description Value
type The resource type "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Subscription contract properties. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Name Description Value
allowTracing Determines whether tracing can be enabled bool
displayName Subscription name. string (required)

Constraints:
Min length = 1
Max length = 100
ownerId User (user id path) for whom subscription is being created in form /users/{userId} string
primaryKey Primary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
scope Scope like /products/{productId} or /apis or /apis/{apiId}. string (required)
secondaryKey Secondary subscription key. If not specified during request key will be generated automatically. string

Constraints:
Min length = 1
Max length = 256
state 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. "active"
"cancelled"
"expired"
"rejected"
"submitted"
"suspended"