virtualmachinescalesetextensions

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-03-01/virtualmachinescalesetextensions Documentation

The virtualmachinescalesetextensions SDK allows for interaction with Azure Resource Manager compute (API Version 2023-03-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/compute/2023-03-01/virtualmachinescalesetextensions"

Client Initialization

client := virtualmachinescalesetextensions.NewVirtualMachineScaleSetExtensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualMachineScaleSetExtensionsClient.CreateOrUpdate

ctx := context.TODO()
id := virtualmachinescalesetextensions.NewVirtualMachineScaleSetExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetName", "vmssExtensionName")

payload := virtualmachinescalesetextensions.VirtualMachineScaleSetExtension{
	// ...
}


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

Example Usage: VirtualMachineScaleSetExtensionsClient.Delete

ctx := context.TODO()
id := virtualmachinescalesetextensions.NewVirtualMachineScaleSetExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetName", "vmssExtensionName")

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

Example Usage: VirtualMachineScaleSetExtensionsClient.Get

ctx := context.TODO()
id := virtualmachinescalesetextensions.NewVirtualMachineScaleSetExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetName", "vmssExtensionName")

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

Example Usage: VirtualMachineScaleSetExtensionsClient.List

ctx := context.TODO()
id := virtualmachinescalesetextensions.NewVirtualMachineScaleSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetName")

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

Example Usage: VirtualMachineScaleSetExtensionsClient.Update

ctx := context.TODO()
id := virtualmachinescalesetextensions.NewVirtualMachineScaleSetExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetName", "vmssExtensionName")

payload := virtualmachinescalesetextensions.VirtualMachineScaleSetExtensionUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateVirtualMachineScaleSetExtensionID 

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

ValidateVirtualMachineScaleSetExtensionID checks that 'input' can be parsed as a Virtual Machine Scale Set Extension ID

func ValidateVirtualMachineScaleSetID 

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

ValidateVirtualMachineScaleSetID checks that 'input' can be parsed as a Virtual Machine Scale Set ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualMachineScaleSetExtension
}

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type KeyVaultSecretReference 

type KeyVaultSecretReference struct {
	SecretUrl   string      `json:"secretUrl"`
	SourceVault SubResource `json:"sourceVault"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualMachineScaleSetExtension
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualMachineScaleSetExtension
}

type SubResource 

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type UpdateOperationResponse 

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

type VirtualMachineScaleSetExtension 

type VirtualMachineScaleSetExtension struct {
	Id         *string                                    `json:"id,omitempty"`
	Name       *string                                    `json:"name,omitempty"`
	Properties *VirtualMachineScaleSetExtensionProperties `json:"properties,omitempty"`
	Type       *string                                    `json:"type,omitempty"`
}

type VirtualMachineScaleSetExtensionId 

type VirtualMachineScaleSetExtensionId struct {
	SubscriptionId             string
	ResourceGroupName          string
	VirtualMachineScaleSetName string
	ExtensionName              string
}

VirtualMachineScaleSetExtensionId is a struct representing the Resource ID for a Virtual Machine Scale Set Extension

func NewVirtualMachineScaleSetExtensionID 

func NewVirtualMachineScaleSetExtensionID(subscriptionId string, resourceGroupName string, virtualMachineScaleSetName string, extensionName string) VirtualMachineScaleSetExtensionId

NewVirtualMachineScaleSetExtensionID returns a new VirtualMachineScaleSetExtensionId struct

func ParseVirtualMachineScaleSetExtensionID 

func ParseVirtualMachineScaleSetExtensionID(input string) (*VirtualMachineScaleSetExtensionId, error)

ParseVirtualMachineScaleSetExtensionID parses 'input' into a VirtualMachineScaleSetExtensionId

func ParseVirtualMachineScaleSetExtensionIDInsensitively 

func ParseVirtualMachineScaleSetExtensionIDInsensitively(input string) (*VirtualMachineScaleSetExtensionId, error)

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

func (*VirtualMachineScaleSetExtensionId) FromParseResult 

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

func (VirtualMachineScaleSetExtensionId) ID 

func (id VirtualMachineScaleSetExtensionId) ID() string

ID returns the formatted Virtual Machine Scale Set Extension ID

func (VirtualMachineScaleSetExtensionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Machine Scale Set Extension ID

func (VirtualMachineScaleSetExtensionId) String 

func (id VirtualMachineScaleSetExtensionId) String() string

String returns a human-readable description of this Virtual Machine Scale Set Extension ID

type VirtualMachineScaleSetExtensionOperationPredicate 

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

func (VirtualMachineScaleSetExtensionOperationPredicate) Matches 

func (p VirtualMachineScaleSetExtensionOperationPredicate) Matches(input VirtualMachineScaleSetExtension) bool

type VirtualMachineScaleSetExtensionProperties 

type VirtualMachineScaleSetExtensionProperties struct {
	AutoUpgradeMinorVersion       *bool                    `json:"autoUpgradeMinorVersion,omitempty"`
	EnableAutomaticUpgrade        *bool                    `json:"enableAutomaticUpgrade,omitempty"`
	ForceUpdateTag                *string                  `json:"forceUpdateTag,omitempty"`
	ProtectedSettings             *interface{}             `json:"protectedSettings,omitempty"`
	ProtectedSettingsFromKeyVault *KeyVaultSecretReference `json:"protectedSettingsFromKeyVault,omitempty"`
	ProvisionAfterExtensions      *[]string                `json:"provisionAfterExtensions,omitempty"`
	ProvisioningState             *string                  `json:"provisioningState,omitempty"`
	Publisher                     *string                  `json:"publisher,omitempty"`
	Settings                      *interface{}             `json:"settings,omitempty"`
	SuppressFailures              *bool                    `json:"suppressFailures,omitempty"`
	Type                          *string                  `json:"type,omitempty"`
	TypeHandlerVersion            *string                  `json:"typeHandlerVersion,omitempty"`
}

type VirtualMachineScaleSetExtensionUpdate 

type VirtualMachineScaleSetExtensionUpdate struct {
	Id         *string                                    `json:"id,omitempty"`
	Name       *string                                    `json:"name,omitempty"`
	Properties *VirtualMachineScaleSetExtensionProperties `json:"properties,omitempty"`
	Type       *string                                    `json:"type,omitempty"`
}

type VirtualMachineScaleSetExtensionsClient 

type VirtualMachineScaleSetExtensionsClient struct {
	Client *resourcemanager.Client
}

func NewVirtualMachineScaleSetExtensionsClientWithBaseURI 

func NewVirtualMachineScaleSetExtensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualMachineScaleSetExtensionsClient, error)

func (VirtualMachineScaleSetExtensionsClient) CreateOrUpdate 

func (c VirtualMachineScaleSetExtensionsClient) CreateOrUpdate(ctx context.Context, id VirtualMachineScaleSetExtensionId, input VirtualMachineScaleSetExtension) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VirtualMachineScaleSetExtensionsClient) CreateOrUpdateThenPoll 

func (c VirtualMachineScaleSetExtensionsClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualMachineScaleSetExtensionId, input VirtualMachineScaleSetExtension) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualMachineScaleSetExtensionsClient) Delete 

func (c VirtualMachineScaleSetExtensionsClient) Delete(ctx context.Context, id VirtualMachineScaleSetExtensionId) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualMachineScaleSetExtensionsClient) DeleteThenPoll 

func (c VirtualMachineScaleSetExtensionsClient) DeleteThenPoll(ctx context.Context, id VirtualMachineScaleSetExtensionId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualMachineScaleSetExtensionsClient) Get 

func (c VirtualMachineScaleSetExtensionsClient) Get(ctx context.Context, id VirtualMachineScaleSetExtensionId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (VirtualMachineScaleSetExtensionsClient) List 

func (c VirtualMachineScaleSetExtensionsClient) List(ctx context.Context, id VirtualMachineScaleSetId) (result ListOperationResponse, err error)

List ...

func (VirtualMachineScaleSetExtensionsClient) ListComplete 

func (c VirtualMachineScaleSetExtensionsClient) ListComplete(ctx context.Context, id VirtualMachineScaleSetId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (VirtualMachineScaleSetExtensionsClient) ListCompleteMatchingPredicate 

func (c VirtualMachineScaleSetExtensionsClient) ListCompleteMatchingPredicate(ctx context.Context, id VirtualMachineScaleSetId, predicate VirtualMachineScaleSetExtensionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualMachineScaleSetExtensionsClient) Update 

func (c VirtualMachineScaleSetExtensionsClient) Update(ctx context.Context, id VirtualMachineScaleSetExtensionId, input VirtualMachineScaleSetExtensionUpdate) (result UpdateOperationResponse, err error)

Update ...

func (VirtualMachineScaleSetExtensionsClient) UpdateThenPoll 

func (c VirtualMachineScaleSetExtensionsClient) UpdateThenPoll(ctx context.Context, id VirtualMachineScaleSetExtensionId, input VirtualMachineScaleSetExtensionUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type VirtualMachineScaleSetId 

type VirtualMachineScaleSetId struct {
	SubscriptionId             string
	ResourceGroupName          string
	VirtualMachineScaleSetName string
}

VirtualMachineScaleSetId is a struct representing the Resource ID for a Virtual Machine Scale Set

func NewVirtualMachineScaleSetID 

func NewVirtualMachineScaleSetID(subscriptionId string, resourceGroupName string, virtualMachineScaleSetName string) VirtualMachineScaleSetId

NewVirtualMachineScaleSetID returns a new VirtualMachineScaleSetId struct

func ParseVirtualMachineScaleSetID 

func ParseVirtualMachineScaleSetID(input string) (*VirtualMachineScaleSetId, error)

ParseVirtualMachineScaleSetID parses 'input' into a VirtualMachineScaleSetId

func ParseVirtualMachineScaleSetIDInsensitively 

func ParseVirtualMachineScaleSetIDInsensitively(input string) (*VirtualMachineScaleSetId, error)

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

func (*VirtualMachineScaleSetId) FromParseResult 

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

func (VirtualMachineScaleSetId) ID 

func (id VirtualMachineScaleSetId) ID() string

ID returns the formatted Virtual Machine Scale Set ID

func (VirtualMachineScaleSetId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Machine Scale Set ID

func (VirtualMachineScaleSetId) String 

func (id VirtualMachineScaleSetId) String() string

String returns a human-readable description of this Virtual Machine Scale Set ID

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.