arcsettings

package
v0.20240425.1225320 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForArcSettingAggregateState 

func PossibleValuesForArcSettingAggregateState() []string

func PossibleValuesForNodeArcState 

func PossibleValuesForNodeArcState() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateArcSettingID 

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

ValidateArcSettingID checks that 'input' can be parsed as a Arc Setting ID

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 ArcIdentityResponse 

type ArcIdentityResponse struct {
	Properties *ArcIdentityResponseProperties `json:"properties,omitempty"`
}

type ArcIdentityResponseProperties 

type ArcIdentityResponseProperties struct {
	ArcApplicationClientId      *string `json:"arcApplicationClientId,omitempty"`
	ArcApplicationObjectId      *string `json:"arcApplicationObjectId,omitempty"`
	ArcApplicationTenantId      *string `json:"arcApplicationTenantId,omitempty"`
	ArcServicePrincipalObjectId *string `json:"arcServicePrincipalObjectId,omitempty"`
}

type ArcSetting 

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

type ArcSettingAggregateState 

type ArcSettingAggregateState string
const (
	ArcSettingAggregateStateAccepted           ArcSettingAggregateState = "Accepted"
	ArcSettingAggregateStateCanceled           ArcSettingAggregateState = "Canceled"
	ArcSettingAggregateStateConnected          ArcSettingAggregateState = "Connected"
	ArcSettingAggregateStateCreating           ArcSettingAggregateState = "Creating"
	ArcSettingAggregateStateDeleted            ArcSettingAggregateState = "Deleted"
	ArcSettingAggregateStateDeleting           ArcSettingAggregateState = "Deleting"
	ArcSettingAggregateStateDisableInProgress  ArcSettingAggregateState = "DisableInProgress"
	ArcSettingAggregateStateDisconnected       ArcSettingAggregateState = "Disconnected"
	ArcSettingAggregateStateError              ArcSettingAggregateState = "Error"
	ArcSettingAggregateStateFailed             ArcSettingAggregateState = "Failed"
	ArcSettingAggregateStateInProgress         ArcSettingAggregateState = "InProgress"
	ArcSettingAggregateStateMoving             ArcSettingAggregateState = "Moving"
	ArcSettingAggregateStateNotSpecified       ArcSettingAggregateState = "NotSpecified"
	ArcSettingAggregateStatePartiallyConnected ArcSettingAggregateState = "PartiallyConnected"
	ArcSettingAggregateStatePartiallySucceeded ArcSettingAggregateState = "PartiallySucceeded"
	ArcSettingAggregateStateProvisioning       ArcSettingAggregateState = "Provisioning"
	ArcSettingAggregateStateSucceeded          ArcSettingAggregateState = "Succeeded"
	ArcSettingAggregateStateUpdating           ArcSettingAggregateState = "Updating"
)

func (*ArcSettingAggregateState) UnmarshalJSON 

func (s *ArcSettingAggregateState) UnmarshalJSON(bytes []byte) error

type ArcSettingId 

type ArcSettingId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	ArcSettingName    string
}

ArcSettingId is a struct representing the Resource ID for a Arc Setting

func NewArcSettingID 

func NewArcSettingID(subscriptionId string, resourceGroupName string, clusterName string, arcSettingName string) ArcSettingId

NewArcSettingID returns a new ArcSettingId struct

func ParseArcSettingID 

func ParseArcSettingID(input string) (*ArcSettingId, error)

ParseArcSettingID parses 'input' into a ArcSettingId

func ParseArcSettingIDInsensitively 

func ParseArcSettingIDInsensitively(input string) (*ArcSettingId, error)

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

func (*ArcSettingId) FromParseResult 

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

func (ArcSettingId) ID 

func (id ArcSettingId) ID() string

ID returns the formatted Arc Setting ID

func (ArcSettingId) Segments 

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

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

func (ArcSettingId) String 

func (id ArcSettingId) String() string

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

type ArcSettingOperationPredicate 

type ArcSettingOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ArcSettingOperationPredicate) Matches 

func (p ArcSettingOperationPredicate) Matches(input ArcSetting) bool

type ArcSettingProperties 

type ArcSettingProperties struct {
	AggregateState              *ArcSettingAggregateState  `json:"aggregateState,omitempty"`
	ArcApplicationClientId      *string                    `json:"arcApplicationClientId,omitempty"`
	ArcApplicationObjectId      *string                    `json:"arcApplicationObjectId,omitempty"`
	ArcApplicationTenantId      *string                    `json:"arcApplicationTenantId,omitempty"`
	ArcInstanceResourceGroup    *string                    `json:"arcInstanceResourceGroup,omitempty"`
	ArcServicePrincipalObjectId *string                    `json:"arcServicePrincipalObjectId,omitempty"`
	ConnectivityProperties      *interface{}               `json:"connectivityProperties,omitempty"`
	DefaultExtensions           *[]DefaultExtensionDetails `json:"defaultExtensions,omitempty"`
	PerNodeDetails              *[]PerNodeState            `json:"perNodeDetails,omitempty"`
	ProvisioningState           *ProvisioningState         `json:"provisioningState,omitempty"`
}

type ArcSettingsClient 

type ArcSettingsClient struct {
	Client *resourcemanager.Client
}

func NewArcSettingsClientWithBaseURI 

func NewArcSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*ArcSettingsClient, error)

func (ArcSettingsClient) ArcSettingsCreate 

func (c ArcSettingsClient) ArcSettingsCreate(ctx context.Context, id ArcSettingId, input ArcSetting) (result ArcSettingsCreateOperationResponse, err error)

ArcSettingsCreate ...

func (ArcSettingsClient) ArcSettingsDelete 

func (c ArcSettingsClient) ArcSettingsDelete(ctx context.Context, id ArcSettingId) (result ArcSettingsDeleteOperationResponse, err error)

ArcSettingsDelete ...

func (ArcSettingsClient) ArcSettingsDeleteThenPoll 

func (c ArcSettingsClient) ArcSettingsDeleteThenPoll(ctx context.Context, id ArcSettingId) error

ArcSettingsDeleteThenPoll performs ArcSettingsDelete then polls until it's completed

func (ArcSettingsClient) ArcSettingsGet 

func (c ArcSettingsClient) ArcSettingsGet(ctx context.Context, id ArcSettingId) (result ArcSettingsGetOperationResponse, err error)

ArcSettingsGet ...

func (ArcSettingsClient) ArcSettingsListByCluster 

func (c ArcSettingsClient) ArcSettingsListByCluster(ctx context.Context, id ClusterId) (result ArcSettingsListByClusterOperationResponse, err error)

ArcSettingsListByCluster ...

func (ArcSettingsClient) ArcSettingsListByClusterComplete 

func (c ArcSettingsClient) ArcSettingsListByClusterComplete(ctx context.Context, id ClusterId) (ArcSettingsListByClusterCompleteResult, error)

ArcSettingsListByClusterComplete retrieves all the results into a single object

func (ArcSettingsClient) ArcSettingsListByClusterCompleteMatchingPredicate 

func (c ArcSettingsClient) ArcSettingsListByClusterCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate ArcSettingOperationPredicate) (result ArcSettingsListByClusterCompleteResult, err error)

ArcSettingsListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ArcSettingsClient) ArcSettingsUpdate 

func (c ArcSettingsClient) ArcSettingsUpdate(ctx context.Context, id ArcSettingId, input ArcSettingsPatch) (result ArcSettingsUpdateOperationResponse, err error)

ArcSettingsUpdate ...

func (ArcSettingsClient) ConsentAndInstallDefaultExtensions 

func (c ArcSettingsClient) ConsentAndInstallDefaultExtensions(ctx context.Context, id ArcSettingId) (result ConsentAndInstallDefaultExtensionsOperationResponse, err error)

ConsentAndInstallDefaultExtensions ...

func (ArcSettingsClient) CreateIdentity 

func (c ArcSettingsClient) CreateIdentity(ctx context.Context, id ArcSettingId) (result CreateIdentityOperationResponse, err error)

CreateIdentity ...

func (ArcSettingsClient) CreateIdentityThenPoll 

func (c ArcSettingsClient) CreateIdentityThenPoll(ctx context.Context, id ArcSettingId) error

CreateIdentityThenPoll performs CreateIdentity then polls until it's completed

func (ArcSettingsClient) GeneratePassword 

func (c ArcSettingsClient) GeneratePassword(ctx context.Context, id ArcSettingId) (result GeneratePasswordOperationResponse, err error)

GeneratePassword ...

func (ArcSettingsClient) InitializeDisableProcess 

func (c ArcSettingsClient) InitializeDisableProcess(ctx context.Context, id ArcSettingId) (result InitializeDisableProcessOperationResponse, err error)

InitializeDisableProcess ...

func (ArcSettingsClient) InitializeDisableProcessThenPoll 

func (c ArcSettingsClient) InitializeDisableProcessThenPoll(ctx context.Context, id ArcSettingId) error

InitializeDisableProcessThenPoll performs InitializeDisableProcess then polls until it's completed

type ArcSettingsCreateOperationResponse 

type ArcSettingsCreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ArcSetting
}

type ArcSettingsDeleteOperationResponse 

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

type ArcSettingsGetOperationResponse 

type ArcSettingsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ArcSetting
}

type ArcSettingsListByClusterCompleteResult 

type ArcSettingsListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ArcSetting
}

type ArcSettingsListByClusterOperationResponse 

type ArcSettingsListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ArcSetting
}

type ArcSettingsPatch 

type ArcSettingsPatch struct {
	Properties *ArcSettingsPatchProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
}

type ArcSettingsPatchProperties 

type ArcSettingsPatchProperties struct {
	ConnectivityProperties *interface{} `json:"connectivityProperties,omitempty"`
}

type ArcSettingsUpdateOperationResponse 

type ArcSettingsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ArcSetting
}

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 ConsentAndInstallDefaultExtensionsOperationResponse 

type ConsentAndInstallDefaultExtensionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ArcSetting
}

type CreateIdentityOperationResponse 

type CreateIdentityOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ArcIdentityResponse
}

type DefaultExtensionDetails 

type DefaultExtensionDetails struct {
	Category    *string `json:"category,omitempty"`
	ConsentTime *string `json:"consentTime,omitempty"`
}

func (*DefaultExtensionDetails) GetConsentTimeAsTime 

func (o *DefaultExtensionDetails) GetConsentTimeAsTime() (*time.Time, error)

func (*DefaultExtensionDetails) SetConsentTimeAsTime 

func (o *DefaultExtensionDetails) SetConsentTimeAsTime(input time.Time)

type GeneratePasswordOperationResponse 

type GeneratePasswordOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PasswordCredential
}

type InitializeDisableProcessOperationResponse 

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

type NodeArcState 

type NodeArcState string
const (
	NodeArcStateAccepted           NodeArcState = "Accepted"
	NodeArcStateCanceled           NodeArcState = "Canceled"
	NodeArcStateConnected          NodeArcState = "Connected"
	NodeArcStateCreating           NodeArcState = "Creating"
	NodeArcStateDeleted            NodeArcState = "Deleted"
	NodeArcStateDeleting           NodeArcState = "Deleting"
	NodeArcStateDisableInProgress  NodeArcState = "DisableInProgress"
	NodeArcStateDisconnected       NodeArcState = "Disconnected"
	NodeArcStateError              NodeArcState = "Error"
	NodeArcStateFailed             NodeArcState = "Failed"
	NodeArcStateInProgress         NodeArcState = "InProgress"
	NodeArcStateMoving             NodeArcState = "Moving"
	NodeArcStateNotSpecified       NodeArcState = "NotSpecified"
	NodeArcStatePartiallyConnected NodeArcState = "PartiallyConnected"
	NodeArcStatePartiallySucceeded NodeArcState = "PartiallySucceeded"
	NodeArcStateProvisioning       NodeArcState = "Provisioning"
	NodeArcStateSucceeded          NodeArcState = "Succeeded"
	NodeArcStateUpdating           NodeArcState = "Updating"
)

func (*NodeArcState) UnmarshalJSON 

func (s *NodeArcState) UnmarshalJSON(bytes []byte) error

type PasswordCredential 

type PasswordCredential struct {
	EndDateTime   *string `json:"endDateTime,omitempty"`
	KeyId         *string `json:"keyId,omitempty"`
	SecretText    *string `json:"secretText,omitempty"`
	StartDateTime *string `json:"startDateTime,omitempty"`
}

func (*PasswordCredential) GetEndDateTimeAsTime 

func (o *PasswordCredential) GetEndDateTimeAsTime() (*time.Time, error)

func (*PasswordCredential) GetStartDateTimeAsTime 

func (o *PasswordCredential) GetStartDateTimeAsTime() (*time.Time, error)

func (*PasswordCredential) SetEndDateTimeAsTime 

func (o *PasswordCredential) SetEndDateTimeAsTime(input time.Time)

func (*PasswordCredential) SetStartDateTimeAsTime 

func (o *PasswordCredential) SetStartDateTimeAsTime(input time.Time)

type PerNodeState 

type PerNodeState struct {
	ArcInstance *string       `json:"arcInstance,omitempty"`
	Name        *string       `json:"name,omitempty"`
	State       *NodeArcState `json:"state,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted           ProvisioningState = "Accepted"
	ProvisioningStateCanceled           ProvisioningState = "Canceled"
	ProvisioningStateConnected          ProvisioningState = "Connected"
	ProvisioningStateCreating           ProvisioningState = "Creating"
	ProvisioningStateDeleted            ProvisioningState = "Deleted"
	ProvisioningStateDeleting           ProvisioningState = "Deleting"
	ProvisioningStateDisableInProgress  ProvisioningState = "DisableInProgress"
	ProvisioningStateDisconnected       ProvisioningState = "Disconnected"
	ProvisioningStateError              ProvisioningState = "Error"
	ProvisioningStateFailed             ProvisioningState = "Failed"
	ProvisioningStateInProgress         ProvisioningState = "InProgress"
	ProvisioningStateMoving             ProvisioningState = "Moving"
	ProvisioningStateNotSpecified       ProvisioningState = "NotSpecified"
	ProvisioningStatePartiallyConnected ProvisioningState = "PartiallyConnected"
	ProvisioningStatePartiallySucceeded ProvisioningState = "PartiallySucceeded"
	ProvisioningStateProvisioning       ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded          ProvisioningState = "Succeeded"
	ProvisioningStateUpdating           ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.