Merge pull request #182 from hashicorp/f/commonids/dedicated-hosts

New Common IDs: Dedicated Host / Dedicated Host Group
hashicorp · Sep 12, 2023 · 07c94a3 · 07c94a3
2 parents 64b4efc + 9be062e
commit 07c94a3
Show file tree

Hide file tree

Showing 4 changed files with 876 additions and 0 deletions.
diff --git a/resourcemanager/commonids/dedicated_host.go b/resourcemanager/commonids/dedicated_host.go
@@ -0,0 +1,140 @@
+// 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 = DedicatedHostId{}
+
+// DedicatedHostId is a struct representing the Resource ID for a Dedicated Host
+type DedicatedHostId struct {
+	SubscriptionId    string
+	ResourceGroupName string
+	HostGroupName     string
+	HostName          string
+}
+
+// NewDedicatedHostID returns a new DedicatedHostId struct
+func NewDedicatedHostID(subscriptionId string, resourceGroupName string, hostGroupName string, hostName string) DedicatedHostId {
+	return DedicatedHostId{
+		SubscriptionId:    subscriptionId,
+		ResourceGroupName: resourceGroupName,
+		HostGroupName:     hostGroupName,
+		HostName:          hostName,
+	}
+}
+
+// ParseDedicatedHostID parses 'input' into a DedicatedHostId
+func ParseDedicatedHostID(input string) (*DedicatedHostId, error) {
+	parser := resourceids.NewParserFromResourceIdType(DedicatedHostId{})
+	parsed, err := parser.Parse(input, false)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := DedicatedHostId{}
+
+	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.HostGroupName, ok = parsed.Parsed["hostGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostGroupName", *parsed)
+	}
+
+	if id.HostName, ok = parsed.Parsed["hostName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ParseDedicatedHostIDInsensitively parses 'input' case-insensitively into a DedicatedHostId
+// note: this method should only be used for API response data and not user input
+func ParseDedicatedHostIDInsensitively(input string) (*DedicatedHostId, error) {
+	parser := resourceids.NewParserFromResourceIdType(DedicatedHostId{})
+	parsed, err := parser.Parse(input, true)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := DedicatedHostId{}
+
+	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.HostGroupName, ok = parsed.Parsed["hostGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostGroupName", *parsed)
+	}
+
+	if id.HostName, ok = parsed.Parsed["hostName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ValidateDedicatedHostID checks that 'input' can be parsed as a Dedicated Host ID
+func ValidateDedicatedHostID(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 := ParseDedicatedHostID(v); err != nil {
+		errors = append(errors, err)
+	}
+
+	return
+}
+
+// ID returns the formatted Dedicated Host ID
+func (id DedicatedHostId) ID() string {
+	fmtString := "/subscriptions/%s/resourceGroups/%s/providers/Microsoft.Compute/hostGroups/%s/hosts/%s"
+	return fmt.Sprintf(fmtString, id.SubscriptionId, id.ResourceGroupName, id.HostGroupName, id.HostName)
+}
+
+// Segments returns a slice of Resource ID Segments which comprise this Dedicated Host ID
+func (id DedicatedHostId) 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("staticHostGroups", "hostGroups", "hostGroups"),
+		resourceids.UserSpecifiedSegment("hostGroupName", "hostGroupValue"),
+		resourceids.StaticSegment("staticHosts", "hosts", "hosts"),
+		resourceids.UserSpecifiedSegment("hostName", "hostValue"),
+	}
+}
+
+// String returns a human-readable description of this DedicatedHost ID
+func (id DedicatedHostId) String() string {
+	components := []string{
+		fmt.Sprintf("Subscription: %q", id.SubscriptionId),
+		fmt.Sprintf("Resource Group Name: %q", id.ResourceGroupName),
+		fmt.Sprintf("Host Group Name: %q", id.HostGroupName),
+		fmt.Sprintf("Host Name: %q", id.HostName),
+	}
+	return fmt.Sprintf("Dedicated Host (%s)", strings.Join(components, "\n"))
+}
diff --git a/resourcemanager/commonids/dedicated_host_group.go b/resourcemanager/commonids/dedicated_host_group.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 = DedicatedHostGroupId{}
+
+// DedicatedHostGroupId is a struct representing the Resource ID for a Dedicated Host Group
+type DedicatedHostGroupId struct {
+	SubscriptionId    string
+	ResourceGroupName string
+	HostGroupName     string
+}
+
+// NewDedicatedHostGroupID returns a new HostGroupId struct
+func NewDedicatedHostGroupID(subscriptionId string, resourceGroupName string, hostGroupName string) DedicatedHostGroupId {
+	return DedicatedHostGroupId{
+		SubscriptionId:    subscriptionId,
+		ResourceGroupName: resourceGroupName,
+		HostGroupName:     hostGroupName,
+	}
+}
+
+// ParseDedicatedHostGroupID parses 'input' into a DedicatedHostGroupId
+func ParseDedicatedHostGroupID(input string) (*DedicatedHostGroupId, error) {
+	parser := resourceids.NewParserFromResourceIdType(DedicatedHostGroupId{})
+	parsed, err := parser.Parse(input, false)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := DedicatedHostGroupId{}
+
+	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.HostGroupName, ok = parsed.Parsed["hostGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostGroupName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ParseDedicatedHostGroupIDInsensitively parses 'input' case-insensitively into a DedicatedHostGroupId
+// note: this method should only be used for API response data and not user input
+func ParseDedicatedHostGroupIDInsensitively(input string) (*DedicatedHostGroupId, error) {
+	parser := resourceids.NewParserFromResourceIdType(DedicatedHostGroupId{})
+	parsed, err := parser.Parse(input, true)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	var ok bool
+	id := DedicatedHostGroupId{}
+
+	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.HostGroupName, ok = parsed.Parsed["hostGroupName"]; !ok {
+		return nil, resourceids.NewSegmentNotSpecifiedError(id, "hostGroupName", *parsed)
+	}
+
+	return &id, nil
+}
+
+// ValidateDedicatedHostGroupID checks that 'input' can be parsed as a Dedicated Host Group ID
+func ValidateDedicatedHostGroupID(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 := ParseDedicatedHostGroupID(v); err != nil {
+		errors = append(errors, err)
+	}
+
+	return
+}
+
+// ID returns the formatted Dedicated Host Group ID
+func (id DedicatedHostGroupId) ID() string {
+	fmtString := "/subscriptions/%s/resourceGroups/%s/providers/Microsoft.Compute/hostGroups/%s"
+	return fmt.Sprintf(fmtString, id.SubscriptionId, id.ResourceGroupName, id.HostGroupName)
+}
+
+// Segments returns a slice of Resource ID Segments which comprise this Dedicated Host Group ID
+func (id DedicatedHostGroupId) 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("staticHostGroups", "hostGroups", "hostGroups"),
+		resourceids.UserSpecifiedSegment("hostGroupName", "hostGroupValue"),
+	}
+}
+
+// String returns a human-readable description of this Dedicated Host Group ID
+func (id DedicatedHostGroupId) String() string {
+	components := []string{
+		fmt.Sprintf("Subscription: %q", id.SubscriptionId),
+		fmt.Sprintf("Resource Group Name: %q", id.ResourceGroupName),
+		fmt.Sprintf("Host Group Name: %q", id.HostGroupName),
+	}
+	return fmt.Sprintf("Dedicated Host Group (%s)", strings.Join(components, "\n"))
+}