package
0.20240125.1100331
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-08-01/arcsettings Documentation

The arcsettings SDK allows for interaction with the Azure Resource Manager Service azurestackhci (API Version 2023-08-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/azurestackhci/2023-08-01/arcsettings"

Client Initialization

client := arcsettings.NewArcSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ArcSettingsClient.ArcSettingsCreate

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

payload := arcsettings.ArcSetting{
	// ...
}


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

Example Usage: ArcSettingsClient.ArcSettingsDelete

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

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

Example Usage: ArcSettingsClient.ArcSettingsGet

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

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

Example Usage: ArcSettingsClient.ArcSettingsListByCluster

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

// alternatively `client.ArcSettingsListByCluster(ctx, id)` can be used to do batched pagination
items, err := client.ArcSettingsListByClusterComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ArcSettingsClient.ArcSettingsUpdate

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

payload := arcsettings.ArcSettingsPatch{
	// ...
}


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

Example Usage: ArcSettingsClient.ConsentAndInstallDefaultExtensions

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

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

Example Usage: ArcSettingsClient.CreateIdentity

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

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

Example Usage: ArcSettingsClient.GeneratePassword

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

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

Example Usage: ArcSettingsClient.InitializeDisableProcess

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

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

# Functions

NewArcSettingID returns a new ArcSettingId struct.
No description provided by the author
NewClusterID returns a new ClusterId struct.
ParseArcSettingID parses 'input' into a ArcSettingId.
ParseArcSettingIDInsensitively parses 'input' case-insensitively into a ArcSettingId note: this method should only be used for API response data and not user input.
ParseClusterID parses 'input' into a ClusterId.
ParseClusterIDInsensitively parses 'input' case-insensitively into a ClusterId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
ValidateArcSettingID checks that 'input' can be parsed as a Arc Setting ID.
ValidateClusterID checks that 'input' can be parsed as a Cluster ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
ArcSettingId is a struct representing the Resource ID for a Arc Setting.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClusterId is a struct representing the Resource ID for a Cluster.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author