configurations

README

github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2021-06-01/configurations Documentation

The configurations SDK allows for interaction with Azure Resource Manager hdinsight (API Version 2021-06-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2021-06-01/configurations"

Client Initialization

client := configurations.NewConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConfigurationsClient.Get

ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "configurationName")

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

Example Usage: ConfigurationsClient.List

ctx := context.TODO()
id := commonids.NewHDInsightClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName")

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

Example Usage: ConfigurationsClient.Update

ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "configurationName")
var payload map[string]string

if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

• func ValidateConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterConfigurations
• type ConfigurationId
  • func NewConfigurationID(subscriptionId string, resourceGroupName string, clusterName string, ...) ConfigurationId
  • func ParseConfigurationID(input string) (*ConfigurationId, error)
  • func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)
  • func (id *ConfigurationId) FromParseResult(input resourceids.ParseResult) error
  • func (id ConfigurationId) ID() string
  • func (id ConfigurationId) Segments() []resourceids.Segment
  • func (id ConfigurationId) String() string
• type ConfigurationsClient
  • func NewConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfigurationsClient, error)
  • func (c ConfigurationsClient) Get(ctx context.Context, id ConfigurationId) (result GetOperationResponse, err error)
  • func (c ConfigurationsClient) List(ctx context.Context, id commonids.HDInsightClusterId) (result ListOperationResponse, err error)
  • func (c ConfigurationsClient) Update(ctx context.Context, id ConfigurationId, input map[string]string) (result UpdateOperationResponse, err error)
  • func (c ConfigurationsClient) UpdateThenPoll(ctx context.Context, id ConfigurationId, input map[string]string) error
• type GetOperationResponse
• type ListOperationResponse
• type UpdateOperationResponse

Functions

func ValidateConfigurationID

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

ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID

Types

type ClusterConfigurations

type ClusterConfigurations struct {
	Configurations *map[string]map[string]string `json:"configurations,omitempty"`
}

type ConfigurationId

type ConfigurationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	ConfigurationName string
}

ConfigurationId is a struct representing the Resource ID for a Configuration

func NewConfigurationID

func NewConfigurationID(subscriptionId string, resourceGroupName string, clusterName string, configurationName string) ConfigurationId

NewConfigurationID returns a new ConfigurationId struct

func ParseConfigurationID

func ParseConfigurationID(input string) (*ConfigurationId, error)

ParseConfigurationID parses 'input' into a ConfigurationId

func ParseConfigurationIDInsensitively

func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)

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

func (*ConfigurationId) FromParseResult

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

func (ConfigurationId) ID

func (id ConfigurationId) ID() string

ID returns the formatted Configuration ID

func (ConfigurationId) Segments

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

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

func (ConfigurationId) String

func (id ConfigurationId) String() string

String returns a human-readable description of this Configuration ID

type ConfigurationsClient

type ConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationsClientWithBaseURI

func NewConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfigurationsClient, error)

func (ConfigurationsClient) Get

func (c ConfigurationsClient) Get(ctx context.Context, id ConfigurationId) (result GetOperationResponse, err error)

Get ...

func (ConfigurationsClient) List

func (c ConfigurationsClient) List(ctx context.Context, id commonids.HDInsightClusterId) (result ListOperationResponse, err error)

List ...

func (ConfigurationsClient) Update

func (c ConfigurationsClient) Update(ctx context.Context, id ConfigurationId, input map[string]string) (result UpdateOperationResponse, err error)

Update ...

func (ConfigurationsClient) UpdateThenPoll

func (c ConfigurationsClient) UpdateThenPoll(ctx context.Context, id ConfigurationId, input map[string]string) error

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *map[string]string
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterConfigurations
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}