eventhubsclustersconfiguration

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/eventhubsclustersconfiguration Documentation

The eventhubsclustersconfiguration SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2024-01-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/eventhubsclustersconfiguration"

Client Initialization

client := eventhubsclustersconfiguration.NewEventHubsClustersConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EventHubsClustersConfigurationClient.ConfigurationGet

ctx := context.TODO()
id := eventhubsclustersconfiguration.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

read, err := client.ConfigurationGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: EventHubsClustersConfigurationClient.ConfigurationPatch

ctx := context.TODO()
id := eventhubsclustersconfiguration.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

payload := eventhubsclustersconfiguration.ClusterQuotaConfigurationProperties{
	// ...
}


read, err := client.ConfigurationPatch(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterId
  • func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId
  • func ParseClusterID(input string) (*ClusterId, error)
  • func ParseClusterIDInsensitively(input string) (*ClusterId, error)
  • func (id *ClusterId) FromParseResult(input resourceids.ParseResult) error
  • func (id ClusterId) ID() string
  • func (id ClusterId) Segments() []resourceids.Segment
  • func (id ClusterId) String() string
• type ClusterQuotaConfigurationProperties
• type ConfigurationGetOperationResponse
• type ConfigurationPatchOperationResponse
• type EventHubsClustersConfigurationClient
  • func NewEventHubsClustersConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*EventHubsClustersConfigurationClient, error)
  • func (c EventHubsClustersConfigurationClient) ConfigurationGet(ctx context.Context, id ClusterId) (result ConfigurationGetOperationResponse, err error)
  • func (c EventHubsClustersConfigurationClient) ConfigurationPatch(ctx context.Context, id ClusterId, input ClusterQuotaConfigurationProperties) (result ConfigurationPatchOperationResponse, err error)

Functions

func ValidateClusterID

func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

Types

type ClusterId

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

ParseClusterIDInsensitively parses 'input' case-insensitively into a ClusterId note: this method should only be used for API response data and not user input

func (*ClusterId) FromParseResult

func (id *ClusterId) FromParseResult(input resourceids.ParseResult) error

func (ClusterId) ID

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments

func (id ClusterId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type ClusterQuotaConfigurationProperties

type ClusterQuotaConfigurationProperties struct {
	Settings *map[string]string `json:"settings,omitempty"`
}

type ConfigurationGetOperationResponse

type ConfigurationGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterQuotaConfigurationProperties
}

type ConfigurationPatchOperationResponse

type ConfigurationPatchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterQuotaConfigurationProperties
}

type EventHubsClustersConfigurationClient

type EventHubsClustersConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewEventHubsClustersConfigurationClientWithBaseURI

func NewEventHubsClustersConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*EventHubsClustersConfigurationClient, error)

func (EventHubsClustersConfigurationClient) ConfigurationGet

func (c EventHubsClustersConfigurationClient) ConfigurationGet(ctx context.Context, id ClusterId) (result ConfigurationGetOperationResponse, err error)

ConfigurationGet ...

func (EventHubsClustersConfigurationClient) ConfigurationPatch

func (c EventHubsClustersConfigurationClient) ConfigurationPatch(ctx context.Context, id ClusterId, input ClusterQuotaConfigurationProperties) (result ConfigurationPatchOperationResponse, err error)

ConfigurationPatch ...