» azurerm_api_management_subscription
Manages a Subscription within a API Management Service.
» Example Usage
data "azurerm_api_management" "test" {
name = "example-apim"
resource_group_name = "example-resources"
}
data "azurerm_api_management_product" "test" {
product_id = "00000000-0000-0000-0000-000000000000"
api_management_name = "${data.azurerm_api_management.test.name}"
resource_group_name = "${data.azurerm_api_management.test.resource_group_name}"
}
data "azurerm_api_management_user" "test" {
user_id = "11111111-1111-1111-1111-111111111111"
api_management_name = "${data.azurerm_api_management.test.name}"
resource_group_name = "${data.azurerm_api_management.test.resource_group_name}"
}
resource "azurerm_api_management_subscription" "test" {
api_management_name = "${data.azurerm_api_management.test.name}"
resource_group_name = "${data.azurerm_api_management.test.resource_group_name}"
user_id = "${data.azurerm_api_management_user.test.id}"
product_id = "${data.azurerm_api_management_product.test.id}"
display_name = "Parser API"
}
» Argument Reference
The following arguments are supported:
-
api_management_name
- (Required) The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created. -
display_name
- (Required) The display name of this Subscription. -
resource_group_name
- (Required) The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. -
product_id
- (Required) The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created. -
user_id
- (Required) The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created.
-
state
- (Optional) The state of this Subscription. Possible values areActive
,Cancelled
,Expired
,Rejected
,Submitted
andSuspended
. Defaults toSubmitted
. -
subscription_id
- (Optional) An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created.
» Attributes Reference
In addition to all arguments above, the following attributes are exported:
-
id
- The ID of the API Management Subscription.
» Import
API Management Subscriptions can be imported using the resource id
, e.g.
terraform import azurerm_api_management_subscription.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/properties/example-apimp