Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The service/workspaces/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/workspaces/subscriptions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/subscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 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/workspaces |
| properties | Subscription contract properties. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Name | Description | Value |
|---|---|---|
| allowTracing | Determines whether tracing can be enabled | bool |
| displayName | Subscription name. | string Constraints: Min length = 1 Max length = 100 (required) |
| 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' |
ARM template resource definition
The service/workspaces/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/workspaces/subscriptions resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/workspaces/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
Microsoft.ApiManagement/service/workspaces/subscriptions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-01-preview' |
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| properties | Subscription contract properties. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/workspaces/subscriptions' |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Name | Description | Value |
|---|---|---|
| allowTracing | Determines whether tracing can be enabled | bool |
| displayName | Subscription name. | string Constraints: Min length = 1 Max length = 100 (required) |
| 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' |
Usage Examples
Terraform (AzAPI provider) resource definition
The service/workspaces/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/workspaces/subscriptions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview"
name = "string"
body = {
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/subscriptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service/workspaces |
| properties | Subscription contract properties. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Name | Description | Value |
|---|---|---|
| allowTracing | Determines whether tracing can be enabled | bool |
| displayName | Subscription name. | string Constraints: Min length = 1 Max length = 100 (required) |
| 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' |