Merge pull request #181 from hashicorp/f/commonids/availability-set

New Common ID: Availability Set
hashicorp · Sep 12, 2023 · 64b4efc · 64b4efc
2 parents 49fbcbb + 9622414
commit 64b4efc
Show file tree

Hide file tree

Showing 2 changed files with 409 additions and 0 deletions.
diff --git a/resourcemanager/commonids/availability_set_id.go b/resourcemanager/commonids/availability_set_id.go
@@ -0,0 +1,127 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package commonids
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/resourceids"
+)
+
+var _ resourceids.ResourceId = AvailabilitySetId{}
+
+// AvailabilitySetId is a struct representing the Resource ID for a Availability Set
+type AvailabilitySetId struct {
+	SubscriptionId      string
+	ResourceGroupName   string
+	AvailabilitySetName string
+}
+
+// NewAvailabilitySetID returns a new AvailabilitySetId struct
+func NewAvailabilitySetID(subscriptionId string, resourceGroupName string, availabilitySetName string) AvailabilitySetId {
+	return AvailabilitySetId{
+		SubscriptionId:      subscriptionId,
+		ResourceGroupName:   resourceGroupName,
+		AvailabilitySetName: availabilitySetName,
+	}
+}
+
+// ParseAvailabilitySetID parses 'input' into a AvailabilitySetId
+func ParseAvailabilitySetID(input string) (*AvailabilitySetId, error) {
+	parser := resourceids.NewParserFromResourceIdType(AvailabilitySetId{})
+	parsed, err := parser.Parse(input, false)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := AvailabilitySetId{}
+
+	if id.SubscriptionId, ok = parsed.Parsed["subscriptionId"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "subscriptionId", *parsed)
+	}
+
+	if id.ResourceGroupName, ok = parsed.Parsed["resourceGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "resourceGroupName", *parsed)
+	}
+
+	if id.AvailabilitySetName, ok = parsed.Parsed["availabilitySetName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "availabilitySetName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ParseAvailabilitySetIDInsensitively parses 'input' case-insensitively into a AvailabilitySetId
+// note: this method should only be used for API response data and not user input
+func ParseAvailabilitySetIDInsensitively(input string) (*AvailabilitySetId, error) {
+	parser := resourceids.NewParserFromResourceIdType(AvailabilitySetId{})
+	parsed, err := parser.Parse(input, true)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := AvailabilitySetId{}
+
+	if id.SubscriptionId, ok = parsed.Parsed["subscriptionId"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "subscriptionId", *parsed)
+	}
+
+	if id.ResourceGroupName, ok = parsed.Parsed["resourceGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "resourceGroupName", *parsed)
+	}
+
+	if id.AvailabilitySetName, ok = parsed.Parsed["availabilitySetName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "availabilitySetName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ValidateAvailabilitySetID checks that 'input' can be parsed as a Availability Set ID
+func ValidateAvailabilitySetID(input interface{}, key string) (warnings []string, errors []error) {
+	v, ok := input.(string)
+	if !ok {
+		errors = append(errors, fmt.Errorf("expected %q to be a string", key))
+		return
+	}
+
+	if _, err := ParseAvailabilitySetID(v); err != nil {
+		errors = append(errors, err)
+	}
+
+	return
+}
+
+// ID returns the formatted Availability Set ID
+func (id AvailabilitySetId) ID() string {
+	fmtString := "/subscriptions/%s/resourceGroups/%s/providers/Microsoft.Compute/availabilitySets/%s"
+	return fmt.Sprintf(fmtString, id.SubscriptionId, id.ResourceGroupName, id.AvailabilitySetName)
+}
+
+// Segments returns a slice of Resource ID Segments which comprise this Availability Set ID
+func (id AvailabilitySetId) Segments() []resourceids.Segment {
+	return []resourceids.Segment{
+		resourceids.StaticSegment("staticSubscriptions", "subscriptions", "subscriptions"),
+		resourceids.SubscriptionIdSegment("subscriptionId", "12345678-1234-9876-4563-123456789012"),
+		resourceids.StaticSegment("staticResourceGroups", "resourceGroups", "resourceGroups"),
+		resourceids.ResourceGroupSegment("resourceGroupName", "example-resource-group"),
+		resourceids.StaticSegment("staticProviders", "providers", "providers"),
+		resourceids.ResourceProviderSegment("staticMicrosoftCompute", "Microsoft.Compute", "Microsoft.Compute"),
+		resourceids.StaticSegment("staticAvailabilitySets", "availabilitySets", "availabilitySets"),
+		resourceids.UserSpecifiedSegment("availabilitySetName", "availabilitySetValue"),
+	}
+}
+
+// String returns a human-readable description of this Availability Set ID
+func (id AvailabilitySetId) String() string {
+	components := []string{
+		fmt.Sprintf("Subscription: %q", id.SubscriptionId),
+		fmt.Sprintf("Resource Group Name: %q", id.ResourceGroupName),
+		fmt.Sprintf("Availability Set Name: %q", id.AvailabilitySetName),
+	}
+	return fmt.Sprintf("Availability Set (%s)", strings.Join(components, "\n"))
+}