azurerm_api_management_api - deprecate sku in favour of the sku_name property

azurerm/data_source_api_management.go

@@ -39,21 +39,9 @@ func dataSourceApiManagementService() *schema.Resource {
 				Computed: true,
 			},
 
-			"sku": {
-				Type:     schema.TypeList,
+			"sku_name": {
+				Type:     schema.TypeString,
 				Computed: true,
-				Elem: &schema.Resource{
-					Schema: map[string]*schema.Schema{
-						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
-						},
-						"capacity": {
-							Type:     schema.TypeInt,
-							Computed: true,
-						},
-					},
-				},
 			},
 
 			"notification_sender_email": {
@@ -198,8 +186,8 @@ func dataSourceApiManagementRead(d *schema.ResourceData, meta interface{}) error
 		}
 	}
 
-	if err := d.Set("sku", flattenDataSourceApiManagementServiceSku(resp.Sku)); err != nil {
-		return fmt.Errorf("Error setting `sku`: %+v", err)
+	if err := d.Set("sku_name", flattenDataSourceApiManagementServiceSku(resp.Sku)); err != nil {
+		return fmt.Errorf("Error setting `sku_name`: %+v", err)
 	}
 
 	flattenAndSetTags(d, resp.Tags)
@@ -289,20 +277,14 @@ func flattenDataSourceApiManagementAdditionalLocations(input *[]apimanagement.Ad
 	return results
 }
 
-func flattenDataSourceApiManagementServiceSku(profile *apimanagement.ServiceSkuProperties) []interface{} {
+func flattenDataSourceApiManagementServiceSku(profile *apimanagement.ServiceSkuProperties) string {
 	if profile == nil {
-		return []interface{}{}
+		return ""
 	}
 
-	sku := make(map[string]interface{})
-
-	sku["name"] = string(profile.Name)
-
-	if profile.Capacity != nil {
-		sku["capacity"] = *profile.Capacity
-	}
+	skuName := fmt.Sprintf("%s_%d", string(profile.Name), *profile.Capacity)
 
-	return []interface{}{sku}
+	return skuName
 }
 
 func apiManagementDataSourceHostnameSchema() map[string]*schema.Schema {

azurerm/helpers/azure/sku.go

@@ -0,0 +1,58 @@
+package azure
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/hashicorp/terraform/helper/schema"
+)
+
+func SplitSku(sku string) (string, int32, error) {
+	skuParts := strings.Split(sku, "_")
+
+	if len(skuParts) != 2 {
+		return "", -1, fmt.Errorf("sku_name(%s) is not formatted properly.", sku)
+	}
+
+	capacity, err := strconv.Atoi(skuParts[1])
+
+	if err != nil {
+		return "", -1, fmt.Errorf("%s in sku_name is not a valid value.", skuParts[1])
+	}
+
+	return skuParts[0], int32(capacity), nil
+}
+
+// SkuNameStringInSlice returns a SchemaValidateFunc which tests if the provided value
+// is of type string and matches the value of an element in the valid slice
+// will test with in lower case if ignoreCase is true will also validate if the
+// capacity if above passed minCapacity value
+func SkuNameStringInSlice(valid []string, minCapacity int32, ignoreCase bool) schema.SchemaValidateFunc {
+	return func(i interface{}, k string) (s []string, es []error) {
+		v, ok := i.(string)
+		if !ok {
+			es = append(es, fmt.Errorf("expected type of %s to be string", k))
+			return
+		}
+
+		name, capacity, err := SplitSku(v)
+
+		if err != nil {
+			es = append(es, err)
+			return
+		}
+
+		for _, str := range valid {
+			if name == str || (ignoreCase && strings.ToLower(name) == strings.ToLower(str)) {
+				if capacity < minCapacity {
+					es = append(es, fmt.Errorf("expected %s capacity value to be greater that %d, got %d", k, minCapacity, capacity))
+				}
+				return
+			}
+		}
+
+		es = append(es, fmt.Errorf("expected %s to be one of %v, got %s", k, valid, name))
+		return
+	}
+}

azurerm/resource_arm_api_management.go

@@ -61,10 +61,13 @@ func resourceArmApiManagementService() *schema.Resource {
 				ValidateFunc: validate.ApiManagementServicePublisherEmail,
 			},
 
+			// Remove in 2.0
 			"sku": {
-				Type:     schema.TypeList,
-				Required: true,
-				MaxItems: 1,
+				Type:          schema.TypeList,
+				Optional:      true,
+				Deprecated:    "This property has been deprecated in favour of the 'sku_name' property and will be removed in version 2.0 of the provider",
+				ConflictsWith: []string{"sku_name"},
+				MaxItems:      1,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"name": {
@@ -77,15 +80,28 @@ func resourceArmApiManagementService() *schema.Resource {
 								string(apimanagement.SkuTypePremium),
 							}, false),
 						},
+
 						"capacity": {
 							Type:         schema.TypeInt,
 							Required:     true,
-							ValidateFunc: validation.IntAtLeast(0),
+							ValidateFunc: validation.IntAtLeast(1),
 						},
 					},
 				},
 			},
 
+			"sku_name": {
+				Type:          schema.TypeString,
+				Optional:      true,
+				ConflictsWith: []string{"sku"},
+				ValidateFunc: azure.SkuNameStringInSlice([]string{
+					string(apimanagement.SkuTypeDeveloper),
+					string(apimanagement.SkuTypeBasic),
+					string(apimanagement.SkuTypeStandard),
+					string(apimanagement.SkuTypePremium),
+				}, 1, false),
+			},
+
 			"identity": {
 				Type:     schema.TypeList,
 				Optional: true,
@@ -366,6 +382,14 @@ func resourceArmApiManagementServiceCreateUpdate(d *schema.ResourceData, meta in
 	client := meta.(*ArmClient).apiManagementServiceClient
 	ctx := meta.(*ArmClient).StopContext
 
+	log.Printf("[INFO] validating SKU for API Management Service.")
+
+	sku := expandAzureRmApiManagementSku(d)
+
+	if sku == nil {
+		return fmt.Errorf("either 'sku_name' or 'sku' must be defined in the configuration file")
+	}
+
 	log.Printf("[INFO] preparing arguments for API Management Service creation.")
 
 	name := d.Get("name").(string)
@@ -387,8 +411,6 @@ func resourceArmApiManagementServiceCreateUpdate(d *schema.ResourceData, meta in
 	location := azureRMNormalizeLocation(d.Get("location").(string))
 	tags := d.Get("tags").(map[string]interface{})
 
-	sku := expandAzureRmApiManagementSku(d)
-
 	publisherName := d.Get("publisher_name").(string)
 	publisherEmail := d.Get("publisher_email").(string)
 	notificationSenderEmail := d.Get("notification_sender_email").(string)
@@ -493,6 +515,7 @@ func resourceArmApiManagementServiceRead(d *schema.ResourceData, meta interface{
 
 	resourceGroup := id.ResourceGroup
 	name := id.Path["service"]
+	skuName := d.Get("sku_name").(string)
 
 	resp, err := client.Get(ctx, resourceGroup, name)
 	if err != nil {
@@ -562,8 +585,21 @@ func resourceArmApiManagementServiceRead(d *schema.ResourceData, meta interface{
 		}
 	}
 
-	if err := d.Set("sku", flattenApiManagementServiceSku(resp.Sku)); err != nil {
-		return fmt.Errorf("Error setting `sku`: %+v", err)
+	if skuName == "" {
+		// Remove in 2.0
+		if sku := resp.Sku; sku != nil {
+			if err := d.Set("sku", flattenApiManagementServiceSku(resp.Sku)); err != nil {
+				return fmt.Errorf("Error setting `sku`: %+v", err)
+			}
+		}
+		d.Set("sku_name", "")
+	} else {
+		if sku := resp.Sku; sku != nil {
+			if err := d.Set("sku_name", flattenApiManagementServiceSkuName(resp.Sku)); err != nil {
+				return fmt.Errorf("Error setting `sku_name`: %+v", err)
+			}
+		}
+		d.Set("sku", "")
 	}
 
 	if err := d.Set("sign_in", flattenApiManagementSignInSettings(signInSettings)); err != nil {
@@ -850,21 +886,49 @@ func flattenAzureRmApiManagementMachineIdentity(identity *apimanagement.ServiceI
 }
 
 func expandAzureRmApiManagementSku(d *schema.ResourceData) *apimanagement.ServiceSkuProperties {
-	vs := d.Get("sku").([]interface{})
-	// guaranteed by MinItems in the schema
-	v := vs[0].(map[string]interface{})
+	var name string
+	var capacity int32
+	var err error
 
-	name := apimanagement.SkuType(v["name"].(string))
-	capacity := int32(v["capacity"].(int))
+	if s := d.Get("sku_name").(string); s != "" {
+		name, capacity, err = azure.SplitSku(s)
+
+		if err != nil {
+			return nil
+		}
+	} else {
+		// Remove in 2.0 timeframe
+		vs := d.Get("sku").([]interface{})
+
+		if len(vs) == 0 {
+			return nil
+		}
+
+		// guaranteed by MinItems in the schema
+		v := vs[0].(map[string]interface{})
+
+		name = v["name"].(string)
+		capacity = int32(v["capacity"].(int))
+	}
 
 	sku := &apimanagement.ServiceSkuProperties{
-		Name:     name,
+		Name:     apimanagement.SkuType(name),
 		Capacity: utils.Int32(capacity),
 	}
 
 	return sku
 }
 
+func flattenApiManagementServiceSkuName(input *apimanagement.ServiceSkuProperties) string {
+	if input == nil {
+		return ""
+	}
+
+	sku := fmt.Sprintf("%s_%d", string(input.Name), *input.Capacity)
+
+	return sku
+}
+
 func flattenApiManagementServiceSku(input *apimanagement.ServiceSkuProperties) []interface{} {
 	if input == nil {
 		return []interface{}{}