r/azurerm_api_management_api_subscription: support for api_id

azurerm/internal/services/apimanagement/api_management_subscription_resource.go

@@ -62,12 +62,20 @@ func resourceApiManagementSubscription() *pluginsdk.Resource {
 				ValidateFunc: validation.StringIsNotEmpty,
 			},
 
-			// TODO this now sets the scope property - either a scope block needs adding or additional properties `api_id` and maybe `all_apis`
 			"product_id": {
-				Type:         pluginsdk.TypeString,
-				Optional:     true,
-				ForceNew:     true,
-				ValidateFunc: validate.ProductID,
+				Type:          pluginsdk.TypeString,
+				Optional:      true,
+				ForceNew:      true,
+				ValidateFunc:  validate.ProductID,
+				ConflictsWith: []string{"api_id"},
+			},
+
+			"api_id": {
+				Type:          pluginsdk.TypeString,
+				Optional:      true,
+				ForceNew:      true,
+				ValidateFunc:  validate.ApiID,
+				ConflictsWith: []string{"product_id"},
 			},
 
 			"state": {
@@ -138,14 +146,25 @@ func resourceApiManagementSubscriptionCreateUpdate(d *pluginsdk.ResourceData, me
 	}
 
 	displayName := d.Get("display_name").(string)
-	productId := d.Get("product_id").(string)
+	productId, productSet := d.GetOk("product_id")
+	apiId, apiSet := d.GetOk("api_id")
 	state := d.Get("state").(string)
 	allowTracing := d.Get("allow_tracing").(bool)
 
+	var scope string
+	switch {
+	case productSet:
+		scope = productId.(string)
+	case apiSet:
+		scope = apiId.(string)
+	default:
+		scope = "all_apis"
+	}
+
 	params := apimanagement.SubscriptionCreateParameters{
 		SubscriptionCreateParameterProperties: &apimanagement.SubscriptionCreateParameterProperties{
 			DisplayName:  utils.String(displayName),
-			Scope:        utils.String(productId),
+			Scope:        utils.String(scope),
 			State:        apimanagement.SubscriptionState(state),
 			AllowTracing: utils.Bool(allowTracing),
 		},
@@ -207,14 +226,22 @@ func resourceApiManagementSubscriptionRead(d *pluginsdk.ResourceData, meta inter
 		d.Set("display_name", props.DisplayName)
 		d.Set("state", string(props.State))
 		productId := ""
+		apiId := ""
 		if *props.Scope != "" {
+			// the scope is either a product or api id or "all_apis" constant
 			parseId, err := parse.ProductID(*props.Scope)
-			if err != nil {
-				return fmt.Errorf("parsing product id %q: %+v", *props.Scope, err)
+			if err == nil {
+				productId = parseId.ID()
+			} else {
+				parsedApiId, err := parse.ApiID(*props.Scope)
+				if err != nil {
+					return fmt.Errorf("parsing scope into product/ api id %q: %+v", *props.Scope, err)
+				}
+				apiId = parsedApiId.ID()
 			}
-			productId = parseId.ID()
 		}
 		d.Set("product_id", productId)
+		d.Set("api_id", apiId)
 		d.Set("user_id", props.OwnerID)
 		d.Set("allow_tracing", props.AllowTracing)
 	}

azurerm/internal/services/apimanagement/api_management_subscription_resource_test.go

@@ -141,6 +141,24 @@ func TestAccApiManagementSubscription_withoutUser(t *testing.T) {
 	})
 }
 
+func TestAccApiManagementSubscription_withApiId(t *testing.T) {
+	data := acceptance.BuildTestData(t, "azurerm_api_management_subscription", "test")
+	r := ApiManagementSubscriptionResource{}
+
+	data.ResourceTest(t, r, []acceptance.TestStep{
+		{
+			Config: r.withApiId(data),
+			Check: acceptance.ComposeTestCheckFunc(
+				check.That(data.ResourceName).ExistsInAzure(r),
+				check.That(data.ResourceName).Key("api_id").Exists(),
+				check.That(data.ResourceName).Key("product_id").HasValue(""),
+				check.That(data.ResourceName).Key("user_id").HasValue(""),
+			),
+		},
+		data.ImportStep(),
+	})
+}
+
 func (ApiManagementSubscriptionResource) Exists(ctx context.Context, clients *clients.Client, state *pluginsdk.InstanceState) (*bool, error) {
 	id, err := parse.SubscriptionID(state.ID)
 	if err != nil {
@@ -232,6 +250,30 @@ resource "azurerm_api_management_subscription" "test" {
 `, r.template(data))
 }
 
+func (ApiManagementSubscriptionResource) withApiId(data acceptance.TestData) string {
+	template := ApiManagementSubscriptionResource{}.template(data)
+	return fmt.Sprintf(`
+%s
+
+resource "azurerm_api_management_api" "test" {
+  name                = "TestApi"
+  resource_group_name = azurerm_api_management.test.resource_group_name
+  api_management_name = azurerm_api_management.test.name
+  revision            = "1"
+  protocols           = ["https"]
+  display_name        = "Test API"
+  path                = "test"
+}
+
+resource "azurerm_api_management_subscription" "test" {
+  resource_group_name = azurerm_api_management.test.resource_group_name
+  api_management_name = azurerm_api_management.test.name
+  api_id              = azurerm_api_management_api.test.id
+  display_name        = "Butter Parser API Enterprise Edition"
+}
+`, template)
+}
+
 func (ApiManagementSubscriptionResource) template(data acceptance.TestData) string {
 	return fmt.Sprintf(`
 provider "azurerm" {

website/docs/r/api_management_subscription.html.markdown

@@ -51,10 +51,16 @@ The following arguments are supported:
 
 * `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.
+* `product_id` - (Optional) The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created.
+
+-> **Info:** Only one of `product_id` and `api_id` can be set. If both are missing `all_apis` scope is used for the subscription.
 
 * `user_id` - (Optional) The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created.
 
+* `api_id` - (Optional) The ID of the API which should be assigned to this Subscription. Changing this forces a new resource to be created.
+
+-> **Info:** Only one of `product_id` and `api_id` can be set. If both are missing `all_apis` scope is used for the subscription.
+
 ---
 
 * `state` - (Optional) The state of this Subscription. Possible values are `active`, `cancelled`, `expired`, `rejected`, `submitted` and `suspended`. Defaults to `submitted`.