Microsoft.ApiManagement service/subscriptions 2016-10-10
- Latest
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep resource definition
The service/subscriptions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2016-10-10' = {
parent: resourceSymbolicName
name: 'string'
primaryKey: 'string'
productId: 'string'
secondaryKey: 'string'
state: 'string'
userId: 'string'
}
Property values
Microsoft.ApiManagement/service/subscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = Pattern = ^[^*#&+:<>?]+$ (required) |
| 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 |
| primaryKey | Primary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| productId | Product (product id path) for which subscription is being created in form /products/{productId} | string (required) |
| secondaryKey | Secondary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| 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' |
| userId | User (user id path) for whom subscription is being created in form /users/{uid} | string (required) |
ARM template resource definition
The service/subscriptions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2016-10-10",
"name": "string",
"primaryKey": "string",
"productId": "string",
"secondaryKey": "string",
"state": "string",
"userId": "string"
}
Property values
Microsoft.ApiManagement/service/subscriptions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2016-10-10' |
| name | The resource name | string Constraints: Max length = Pattern = ^[^*#&+:<>?]+$ (required) |
| primaryKey | Primary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| productId | Product (product id path) for which subscription is being created in form /products/{productId} | string (required) |
| secondaryKey | Secondary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| 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' |
| type | The resource type | 'Microsoft.ApiManagement/service/subscriptions' |
| userId | User (user id path) for whom subscription is being created in form /users/{uid} | string (required) |
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@2016-10-10"
name = "string"
primaryKey = "string"
productId = "string"
secondaryKey = "string"
state = "string"
userId = "string"
}
Property values
Microsoft.ApiManagement/service/subscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = Pattern = ^[^*#&+:<>?]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| primaryKey | Primary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| productId | Product (product id path) for which subscription is being created in form /products/{productId} | string (required) |
| secondaryKey | Secondary subscription key. If not specified during request key will be generated automatically. | string Constraints: Min length = 1 Max length = 1 |
| 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' |
| type | The resource type | "Microsoft.ApiManagement/service/subscriptions@2016-10-10" |
| userId | User (user id path) for whom subscription is being created in form /users/{uid} | string (required) |