Added table azure_reservation_recommendation Closes #666

azure/plugin.go

@@ -144,6 +144,7 @@ func Plugin(ctx context.Context) *plugin.Plugin {
 			"azure_redis_cache":                                           tableAzureRedisCache(ctx),
 			"azure_resource_group":                                        tableAzureResourceGroup(ctx),
 			"azure_resource_link":                                         tableAzureResourceLink(ctx),
+			"azure_reservation_recommendation":                            tableAzureReservationRecommendation(ctx),
 			"azure_role_assignment":                                       tableAzureIamRoleAssignment(ctx),
 			"azure_role_definition":                                       tableAzureIamRoleDefinition(ctx),
 			"azure_route_table":                                           tableAzureRouteTable(ctx),

azure/table_azure_reservation_recommendation.go

@@ -0,0 +1,377 @@
+package azure
+
+import (
+	"context"
+
+	"github.com/Azure/azure-sdk-for-go/profiles/latest/consumption/mgmt/consumption"
+	"github.com/turbot/steampipe-plugin-sdk/v5/grpc/proto"
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin/transform"
+
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
+)
+
+//// TABLE DEFINITION
+
+func tableAzureReservationRecommendation(ctx context.Context) *plugin.Table {
+	return &plugin.Table{
+		Name:        "azure_reservation_recommendation",
+		Description: "Azure Reservation Recommendation",
+		List: &plugin.ListConfig{
+			Hydrate: listReservedInstanceRecomendations,
+			KeyColumns: plugin.KeyColumnSlice{
+				{Name: "look_back_period", Require: plugin.Optional, Operators: []string{"="}},
+				{Name: "resource_type", Require: plugin.Optional, Operators: []string{"="}},
+				{Name: "scope", Require: plugin.Optional, Operators: []string{"="}},
+			},
+		},
+		Columns: azureColumns([]*plugin.Column{
+			{
+				Name:        "name",
+				Type:        proto.ColumnType_STRING,
+				Description: "The ID that uniquely identifies an event.",
+			},
+			{
+				Name:        "id",
+				Description: "The full qualified ARM ID of an event.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromGo(),
+			},
+			{
+				Name:        "kind",
+				Description: "Specifies the kind of reservation recommendation.",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "look_back_period",
+				Description: "The number of days of usage to look back for recommendation. Allowed values Last7Days, Last30Days, Last60Days and default value is Last7Days.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromQual("look_back_period"),
+				Default:     "Last7Days'",
+			},
+			{
+				Name:        "resource_type",
+				Description: "The type of resource for recommendation. Possible values are: VirtualMachines, SQLDatabases, PostgreSQL, ManagedDisk, MySQL, RedHat, MariaDB, RedisCache, CosmosDB, SqlDataWarehouse, SUSELinux, AppService, BlockBlob, AzureDataExplorer, VMwareCloudSimple and default value is VirtualMachines.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromQual("resource_type"),
+				Default:     "VirtualMachines",
+			},
+			{
+				Name:        "scope",
+				Description: "Shared or single recommendation. allowed values 'Single' or 'Shared' and default value is Single.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromQual("scope"),
+				Default:     "Single",
+			},
+			{
+				Name:        "etag",
+				Description: "The etag for the resource.",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "type",
+				Description: "Resource type.",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "sku",
+				Description: "Resource sku.",
+				Type:        proto.ColumnType_STRING,
+			},
+
+			// JSON fields
+			{
+				Name:        "legacy_recommendation_properties",
+				Description: "The legacy recommendation properties.",
+				Type:        proto.ColumnType_JSON,
+			},
+			{
+				Name:        "modern_recommendation_properties",
+				Description: "The legacy recommendation properties.",
+				Type:        proto.ColumnType_JSON,
+			},
+
+			// Steampipe standard columns
+			{
+				Name:        "title",
+				Description: ColumnDescriptionTitle,
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromField("Name"),
+			},
+			{
+				Name:        "tags",
+				Description: ColumnDescriptionTags,
+				Type:        proto.ColumnType_JSON,
+			},
+			{
+				Name:        "akas",
+				Description: ColumnDescriptionAkas,
+				Type:        proto.ColumnType_JSON,
+				Transform:   transform.FromField("ID").Transform(idToAkas),
+			},
+
+			// Azure standard columns
+			{
+				Name:        "region",
+				Description: ColumnDescriptionRegion,
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromField("Location").Transform(toLower),
+			},
+		}),
+	}
+}
+
+type RecomendationInfo struct {
+	LegacyRecommendationProperties map[string]interface{}
+	ModernRecommendationProperties map[string]interface{}
+	ID                             *string
+	Name                           *string
+	Type                           *string
+	Etag                           *string
+	Tags                           map[string]*string
+	Location                       *string
+	Sku                            *string
+	Kind                           consumption.KindBasicReservationRecommendation
+}
+
+//// LIST FUNCTION
+
+func listReservedInstanceRecomendations(ctx context.Context, d *plugin.QueryData, _ *plugin.HydrateData) (interface{}, error) {
+	session, err := GetNewSession(ctx, d, "MANAGEMENT")
+	if err != nil {
+		return nil, err
+	}
+	subscriptionID := session.SubscriptionID
+
+	reservedInstanceClient := consumption.NewReservationRecommendationsClientWithBaseURI(session.ResourceManagerEndpoint, subscriptionID)
+	reservedInstanceClient.Authorizer = session.Authorizer
+
+	// E.g: properties/scope eq 'Single' AND properties/lookBackPeriod eq 'Last7Days' AND properties/resourceType eq 'VirtualMachines'"
+	filter := buildReservationRecomendationFilter(d.Quals)
+
+	recommendationScope := "/subscriptions/"+subscriptionID+"/"
+	result, err := reservedInstanceClient.List(ctx, recommendationScope, filter)
+	if err != nil {
+		return nil, err
+	}
+	for _, recomendation := range result.Values() {
+		for _, r := range getReservationRecomendationProperties(recomendation) {
+			d.StreamListItem(ctx, r)
+
+			// Check if context has been cancelled or if the limit has been hit (if specified)
+			// if there is a limit, it will return the number of rows required to reach this limit
+			if d.RowsRemaining(ctx) == 0 {
+				return nil, nil
+			}
+		}
+	}
+
+	for result.NotDone() {
+		err = result.NextWithContext(ctx)
+		if err != nil {
+			return nil, err
+		}
+		for _, recomendation := range result.Values() {
+			for _, r := range getReservationRecomendationProperties(recomendation) {
+				d.StreamListItem(ctx, r)
+
+				// Check if context has been cancelled or if the limit has been hit (if specified)
+				// if there is a limit, it will return the number of rows required to reach this limit
+				if d.RowsRemaining(ctx) == 0 {
+					return nil, nil
+				}
+			}
+		}
+	}
+
+	return nil, err
+}
+
+//// EXTRACT PROPERTIES
+
+func getReservationRecomendationProperties(data consumption.BasicReservationRecommendation) []*RecomendationInfo {
+	var results []*RecomendationInfo
+	lInfo, isLegacy := data.AsLegacyReservationRecommendation()
+	mInfo, isModern := data.AsModernReservationRecommendation()
+	info, is := data.AsReservationRecommendation()
+	if is {
+		result := &RecomendationInfo{}
+		result.Etag = info.Etag
+		result.ID = info.ID
+		result.Kind = info.Kind
+		result.Location = info.Location
+		result.Name = info.Name
+		result.Sku = info.Sku
+		result.Tags = info.Tags
+		result.Type = info.Type
+		results = append(results, result)
+	}
+	if isModern {
+		result := &RecomendationInfo{}
+		result.Etag = mInfo.Etag
+		result.ID = mInfo.ID
+		result.Kind = mInfo.Kind
+		result.Location = mInfo.Location
+		result.Name = mInfo.Name
+		result.Sku = mInfo.Sku
+		result.Tags = mInfo.Tags
+		result.Type = mInfo.Type
+		result.ModernRecommendationProperties = extractRecomemendationProperties(mInfo.ModernReservationRecommendationProperties)
+		results = append(results, result)
+	}
+
+	if isLegacy {
+		result := &RecomendationInfo{}
+		result.Etag = lInfo.Etag
+		result.ID = lInfo.ID
+		result.Kind = lInfo.Kind
+		result.Location = lInfo.Location
+		result.Name = lInfo.Name
+		result.Sku = lInfo.Sku
+		result.Tags = lInfo.Tags
+		result.Type = lInfo.Type
+		result.LegacyRecommendationProperties = extractRecomemendationProperties(lInfo.LegacyReservationRecommendationProperties)
+		results = append(results, result)
+	}
+
+	return results
+}
+
+func extractRecomemendationProperties(r interface{}) map[string]interface{} {
+	objectMap := make(map[string]interface{})
+	switch item := r.(type) {
+	case *consumption.LegacyReservationRecommendationProperties:
+		if item != nil {
+			if item.LookBackPeriod != nil {
+				objectMap["LookBackPeriod"] = *item.LookBackPeriod
+			}
+			if item.InstanceFlexibilityRatio != nil {
+				objectMap["InstanceFlexibilityRatio"] = *item.InstanceFlexibilityRatio
+			}
+			if item.InstanceFlexibilityGroup != nil {
+				objectMap["InstanceFlexibilityGroup"] = *item.InstanceFlexibilityGroup
+			}
+			if item.NormalizedSize != nil {
+				objectMap["NormalizedSize"] = *item.NormalizedSize
+			}
+			if item.RecommendedQuantityNormalized != nil {
+				objectMap["RecommendedQuantityNormalized"] = *item.RecommendedQuantityNormalized
+			}
+			if item.MeterID != nil {
+				objectMap["MeterID"] = *item.MeterID
+			}
+			if item.ResourceType != nil {
+				objectMap["ResourceType"] = *item.ResourceType
+			}
+			if item.Term != nil {
+				objectMap["Term"] = *item.Term
+			}
+			if item.CostWithNoReservedInstances != nil {
+				objectMap["CostWithNoReservedInstances"] = *item.CostWithNoReservedInstances
+			}
+			if item.RecommendedQuantity != nil {
+				objectMap["RecommendedQuantity"] = *item.RecommendedQuantity
+			}
+			if item.TotalCostWithReservedInstances != nil {
+				objectMap["TotalCostWithReservedInstances"] = *item.TotalCostWithReservedInstances
+			}
+			if item.NetSavings != nil {
+				objectMap["NetSavings"] = *item.NetSavings
+			}
+			if item.FirstUsageDate != nil {
+				objectMap["FirstUsageDate"] = *item.FirstUsageDate
+			}
+			if item.Scope != nil {
+				objectMap["Scope"] = *item.Scope
+			}
+			if item.SkuProperties != nil {
+				objectMap["SkuProperties"] = *item.SkuProperties
+			}
+		}
+	case *consumption.ModernReservationRecommendationProperties:
+		if item != nil {
+			if item.Location != nil {
+				objectMap["Location"] = *item.Location
+			}
+			if item.LookBackPeriod != nil {
+				objectMap["LookBackPeriod"] = *item.LookBackPeriod
+			}
+			if item.InstanceFlexibilityRatio != nil {
+				objectMap["InstanceFlexibilityRatio"] = *item.InstanceFlexibilityRatio
+			}
+			if item.InstanceFlexibilityGroup != nil {
+				objectMap["InstanceFlexibilityGroup"] = *item.InstanceFlexibilityGroup
+			}
+			if item.NormalizedSize != nil {
+				objectMap["NormalizedSize"] = *item.NormalizedSize
+			}
+			if item.RecommendedQuantityNormalized != nil {
+				objectMap["RecommendedQuantityNormalized"] = *item.RecommendedQuantityNormalized
+			}
+			if item.MeterID != nil {
+				objectMap["MeterID"] = *item.MeterID
+			}
+			if item.Term != nil {
+				objectMap["Term"] = *item.Term
+			}
+			if item.CostWithNoReservedInstances != nil {
+				objectMap["CostWithNoReservedInstances"] = *item.CostWithNoReservedInstances
+			}
+			if item.RecommendedQuantity != nil {
+				objectMap["RecommendedQuantity"] = *item.RecommendedQuantity
+			}
+			if item.TotalCostWithReservedInstances != nil {
+				objectMap["TotalCostWithReservedInstances"] = *item.TotalCostWithReservedInstances
+			}
+			if item.NetSavings != nil {
+				objectMap["NetSavings"] = *item.NetSavings
+			}
+			if item.FirstUsageDate != nil {
+				objectMap["FirstUsageDate"] = *item.FirstUsageDate
+			}
+			if item.Scope != nil {
+				objectMap["Scope"] = *item.Scope
+			}
+			if item.SkuProperties != nil {
+				objectMap["SkuProperties"] = *item.SkuProperties
+			}
+			if item.SkuName != nil {
+				objectMap["SkuName"] = *item.SkuName
+			}
+			if item.ResourceType != nil {
+				objectMap["ResourceType"] = *item.ResourceType
+			}
+			if item.SubscriptionID != nil {
+				objectMap["SubscriptionID"] = *item.SubscriptionID
+			}
+		}
+	}
+	return objectMap
+}
+
+//// BUILD INPUT FILTER FROM QUALS VALUE
+
+func buildReservationRecomendationFilter(quals plugin.KeyColumnQualMap) string {
+	filter := ""
+
+	filterQuals := map[string]string{
+		"look_back_period": "properties/lookBackPeriod",
+		"resource_type":    "properties/resourceType",
+		"scope":            "properties/scope",
+	}
+
+	for columnName, filterName := range filterQuals {
+		if quals[columnName] != nil {
+			for _, q := range quals[columnName].Quals {
+				if q.Operator == "=" {
+					if filter == "" {
+						filter = filterName + " eq " + "'"+q.Value.GetStringValue()+"'"
+					} else {
+						filter += " AND " + filterName + " eq " + "'"+q.Value.GetStringValue()+"'"
+					}
+				}
+			}
+		}
+	}
+
+	return filter
+}