extensions

package
v0.20230210.1121632 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2022-09-01/extensions Documentation

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

Client Initialization

client := extensions.NewExtensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExtensionsClient.ExtensionsCreate

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

payload := extensions.Extension{
	// ...
}


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

Example Usage: ExtensionsClient.ExtensionsDelete

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

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

Example Usage: ExtensionsClient.ExtensionsGet

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

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

Example Usage: ExtensionsClient.ExtensionsListByArcSetting

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

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

Example Usage: ExtensionsClient.ExtensionsUpdate

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

payload := extensions.Extension{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForExtensionAggregateState 

func PossibleValuesForExtensionAggregateState() []string

func PossibleValuesForNodeExtensionState 

func PossibleValuesForNodeExtensionState() []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 ValidateExtensionID 

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

ValidateExtensionID checks that 'input' can be parsed as a Extension ID

Types

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) 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 Extension 

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

type ExtensionAggregateState 

type ExtensionAggregateState string
const (
	ExtensionAggregateStateCanceled           ExtensionAggregateState = "Canceled"
	ExtensionAggregateStateConnected          ExtensionAggregateState = "Connected"
	ExtensionAggregateStateCreating           ExtensionAggregateState = "Creating"
	ExtensionAggregateStateDeleted            ExtensionAggregateState = "Deleted"
	ExtensionAggregateStateDeleting           ExtensionAggregateState = "Deleting"
	ExtensionAggregateStateDisconnected       ExtensionAggregateState = "Disconnected"
	ExtensionAggregateStateError              ExtensionAggregateState = "Error"
	ExtensionAggregateStateFailed             ExtensionAggregateState = "Failed"
	ExtensionAggregateStateInProgress         ExtensionAggregateState = "InProgress"
	ExtensionAggregateStateMoving             ExtensionAggregateState = "Moving"
	ExtensionAggregateStateNotSpecified       ExtensionAggregateState = "NotSpecified"
	ExtensionAggregateStatePartiallyConnected ExtensionAggregateState = "PartiallyConnected"
	ExtensionAggregateStatePartiallySucceeded ExtensionAggregateState = "PartiallySucceeded"
	ExtensionAggregateStateSucceeded          ExtensionAggregateState = "Succeeded"
	ExtensionAggregateStateUpdating           ExtensionAggregateState = "Updating"
)

type ExtensionId 

type ExtensionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	ArcSettingName    string
	ExtensionName     string
}

ExtensionId is a struct representing the Resource ID for a Extension

func NewExtensionID 

func NewExtensionID(subscriptionId string, resourceGroupName string, clusterName string, arcSettingName string, extensionName string) ExtensionId

NewExtensionID returns a new ExtensionId struct

func ParseExtensionID 

func ParseExtensionID(input string) (*ExtensionId, error)

ParseExtensionID parses 'input' into a ExtensionId

func ParseExtensionIDInsensitively 

func ParseExtensionIDInsensitively(input string) (*ExtensionId, error)

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

func (ExtensionId) ID 

func (id ExtensionId) ID() string

ID returns the formatted Extension ID

func (ExtensionId) Segments 

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

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

func (ExtensionId) String 

func (id ExtensionId) String() string

String returns a human-readable description of this Extension ID

type ExtensionOperationPredicate 

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

func (ExtensionOperationPredicate) Matches 

func (p ExtensionOperationPredicate) Matches(input Extension) bool

type ExtensionParameters 

type ExtensionParameters struct {
	AutoUpgradeMinorVersion *bool        `json:"autoUpgradeMinorVersion,omitempty"`
	ForceUpdateTag          *string      `json:"forceUpdateTag,omitempty"`
	ProtectedSettings       *interface{} `json:"protectedSettings,omitempty"`
	Publisher               *string      `json:"publisher,omitempty"`
	Settings                *interface{} `json:"settings,omitempty"`
	Type                    *string      `json:"type,omitempty"`
	TypeHandlerVersion      *string      `json:"typeHandlerVersion,omitempty"`
}

type ExtensionProperties 

type ExtensionProperties struct {
	AggregateState          *ExtensionAggregateState `json:"aggregateState,omitempty"`
	ExtensionParameters     *ExtensionParameters     `json:"extensionParameters,omitempty"`
	PerNodeExtensionDetails *[]PerNodeExtensionState `json:"perNodeExtensionDetails,omitempty"`
	ProvisioningState       *ProvisioningState       `json:"provisioningState,omitempty"`
}

type ExtensionsClient 

type ExtensionsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewExtensionsClientWithBaseURI 

func NewExtensionsClientWithBaseURI(endpoint string) ExtensionsClient

func (ExtensionsClient) ExtensionsCreate 

func (c ExtensionsClient) ExtensionsCreate(ctx context.Context, id ExtensionId, input Extension) (result ExtensionsCreateOperationResponse, err error)

ExtensionsCreate ...

func (ExtensionsClient) ExtensionsCreateThenPoll 

func (c ExtensionsClient) ExtensionsCreateThenPoll(ctx context.Context, id ExtensionId, input Extension) error

ExtensionsCreateThenPoll performs ExtensionsCreate then polls until it's completed

func (ExtensionsClient) ExtensionsDelete 

func (c ExtensionsClient) ExtensionsDelete(ctx context.Context, id ExtensionId) (result ExtensionsDeleteOperationResponse, err error)

ExtensionsDelete ...

func (ExtensionsClient) ExtensionsDeleteThenPoll 

func (c ExtensionsClient) ExtensionsDeleteThenPoll(ctx context.Context, id ExtensionId) error

ExtensionsDeleteThenPoll performs ExtensionsDelete then polls until it's completed

func (ExtensionsClient) ExtensionsGet 

func (c ExtensionsClient) ExtensionsGet(ctx context.Context, id ExtensionId) (result ExtensionsGetOperationResponse, err error)

ExtensionsGet ...

func (ExtensionsClient) ExtensionsListByArcSetting 

func (c ExtensionsClient) ExtensionsListByArcSetting(ctx context.Context, id ArcSettingId) (resp ExtensionsListByArcSettingOperationResponse, err error)

ExtensionsListByArcSetting ...

func (ExtensionsClient) ExtensionsListByArcSettingComplete 

func (c ExtensionsClient) ExtensionsListByArcSettingComplete(ctx context.Context, id ArcSettingId) (ExtensionsListByArcSettingCompleteResult, error)

ExtensionsListByArcSettingComplete retrieves all of the results into a single object

func (ExtensionsClient) ExtensionsListByArcSettingCompleteMatchingPredicate 

func (c ExtensionsClient) ExtensionsListByArcSettingCompleteMatchingPredicate(ctx context.Context, id ArcSettingId, predicate ExtensionOperationPredicate) (resp ExtensionsListByArcSettingCompleteResult, err error)

ExtensionsListByArcSettingCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ExtensionsClient) ExtensionsUpdate 

func (c ExtensionsClient) ExtensionsUpdate(ctx context.Context, id ExtensionId, input Extension) (result ExtensionsUpdateOperationResponse, err error)

ExtensionsUpdate ...

func (ExtensionsClient) ExtensionsUpdateThenPoll 

func (c ExtensionsClient) ExtensionsUpdateThenPoll(ctx context.Context, id ExtensionId, input Extension) error

ExtensionsUpdateThenPoll performs ExtensionsUpdate then polls until it's completed

type ExtensionsCreateOperationResponse 

type ExtensionsCreateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ExtensionsDeleteOperationResponse 

type ExtensionsDeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ExtensionsGetOperationResponse 

type ExtensionsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Extension
}

type ExtensionsListByArcSettingCompleteResult 

type ExtensionsListByArcSettingCompleteResult struct {
	Items []Extension
}

type ExtensionsListByArcSettingOperationResponse 

type ExtensionsListByArcSettingOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Extension
	// contains filtered or unexported fields
}

func (ExtensionsListByArcSettingOperationResponse) HasMore 

func (r ExtensionsListByArcSettingOperationResponse) HasMore() bool

func (ExtensionsListByArcSettingOperationResponse) LoadMore 

func (r ExtensionsListByArcSettingOperationResponse) LoadMore(ctx context.Context) (resp ExtensionsListByArcSettingOperationResponse, err error)

type ExtensionsUpdateOperationResponse 

type ExtensionsUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type NodeExtensionState 

type NodeExtensionState string
const (
	NodeExtensionStateCanceled     NodeExtensionState = "Canceled"
	NodeExtensionStateConnected    NodeExtensionState = "Connected"
	NodeExtensionStateCreating     NodeExtensionState = "Creating"
	NodeExtensionStateDeleted      NodeExtensionState = "Deleted"
	NodeExtensionStateDeleting     NodeExtensionState = "Deleting"
	NodeExtensionStateDisconnected NodeExtensionState = "Disconnected"
	NodeExtensionStateError        NodeExtensionState = "Error"
	NodeExtensionStateFailed       NodeExtensionState = "Failed"
	NodeExtensionStateMoving       NodeExtensionState = "Moving"
	NodeExtensionStateNotSpecified NodeExtensionState = "NotSpecified"
	NodeExtensionStateSucceeded    NodeExtensionState = "Succeeded"
	NodeExtensionStateUpdating     NodeExtensionState = "Updating"
)

type PerNodeExtensionState 

type PerNodeExtensionState struct {
	Extension *string             `json:"extension,omitempty"`
	Name      *string             `json:"name,omitempty"`
	State     *NodeExtensionState `json:"state,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

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.