settings

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2024-05-20-preview/settings Documentation

The settings SDK allows for interaction with the Azure Resource Manager Service hybridcompute (API Version 2024-05-20-preview).

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/hybridcompute/2024-05-20-preview/settings"

Client Initialization

client := settings.NewSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SettingsClient.Get

ctx := context.TODO()
id := settings.NewScopedSettingID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "settingValue")

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: SettingsClient.Patch

ctx := context.TODO()
id := settings.NewScopedSettingID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "settingValue")

payload := settings.Settings{
	// ...
}


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

Example Usage: SettingsClient.Update

ctx := context.TODO()
id := settings.NewScopedSettingID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "settingValue")

payload := settings.Settings{
	// ...
}


read, err := client.Update(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 ValidateScopedSettingID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type PatchOperationResponse
• type ScopedSettingId
  • func NewScopedSettingID(scope string, settingName string) ScopedSettingId
  • func ParseScopedSettingID(input string) (*ScopedSettingId, error)
  • func ParseScopedSettingIDInsensitively(input string) (*ScopedSettingId, error)
  • func (id *ScopedSettingId) FromParseResult(input resourceids.ParseResult) error
  • func (id ScopedSettingId) ID() string
  • func (id ScopedSettingId) Segments() []resourceids.Segment
  • func (id ScopedSettingId) String() string
• type Settings
• type SettingsClient
  • func NewSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SettingsClient, error)
  • func (c SettingsClient) Get(ctx context.Context, id ScopedSettingId) (result GetOperationResponse, err error)
  • func (c SettingsClient) Patch(ctx context.Context, id ScopedSettingId, input Settings) (result PatchOperationResponse, err error)
  • func (c SettingsClient) Update(ctx context.Context, id ScopedSettingId, input Settings) (result UpdateOperationResponse, err error)
• type SettingsGatewayProperties
• type SettingsProperties
• type UpdateOperationResponse

Functions

func ValidateScopedSettingID

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

ValidateScopedSettingID checks that 'input' can be parsed as a Scoped Setting ID

Types

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Settings
}

type PatchOperationResponse

type PatchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Settings
}

type ScopedSettingId

type ScopedSettingId struct {
	Scope       string
	SettingName string
}

ScopedSettingId is a struct representing the Resource ID for a Scoped Setting

func NewScopedSettingID

func NewScopedSettingID(scope string, settingName string) ScopedSettingId

NewScopedSettingID returns a new ScopedSettingId struct

func ParseScopedSettingID

func ParseScopedSettingID(input string) (*ScopedSettingId, error)

ParseScopedSettingID parses 'input' into a ScopedSettingId

func ParseScopedSettingIDInsensitively

func ParseScopedSettingIDInsensitively(input string) (*ScopedSettingId, error)

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

func (*ScopedSettingId) FromParseResult

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

func (ScopedSettingId) ID

func (id ScopedSettingId) ID() string

ID returns the formatted Scoped Setting ID

func (ScopedSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Setting ID

func (ScopedSettingId) String

func (id ScopedSettingId) String() string

String returns a human-readable description of this Scoped Setting ID

type Settings

type Settings struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *SettingsProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type SettingsClient

type SettingsClient struct {
	Client *resourcemanager.Client
}

func NewSettingsClientWithBaseURI

func NewSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*SettingsClient, error)

func (SettingsClient) Get

func (c SettingsClient) Get(ctx context.Context, id ScopedSettingId) (result GetOperationResponse, err error)

Get ...

func (SettingsClient) Patch

func (c SettingsClient) Patch(ctx context.Context, id ScopedSettingId, input Settings) (result PatchOperationResponse, err error)

Patch ...

func (SettingsClient) Update

func (c SettingsClient) Update(ctx context.Context, id ScopedSettingId, input Settings) (result UpdateOperationResponse, err error)

Update ...

type SettingsGatewayProperties

type SettingsGatewayProperties struct {
	GatewayResourceId *string `json:"gatewayResourceId,omitempty"`
}

type SettingsProperties

type SettingsProperties struct {
	GatewayProperties *SettingsGatewayProperties `json:"gatewayProperties,omitempty"`
	TenantId          *string                    `json:"tenantId,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Settings
}