virtualmachinescalesetvmextensions

package
v0.20231124.1163225 Latest Latest
Warning

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

Go to latest
Published: Nov 24, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The virtualmachinescalesetvmextensions SDK allows for interaction with the Azure Resource Manager Service 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/virtualmachinescalesetvmextensions"

Client Initialization

client := virtualmachinescalesetvmextensions.NewVirtualMachineScaleSetVMExtensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualMachineScaleSetVMExtensionsClient.CreateOrUpdate

ctx := context.TODO()
id := virtualmachinescalesetvmextensions.NewVirtualMachineExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetValue", "instanceIdValue", "extensionValue")

payload := virtualmachinescalesetvmextensions.VirtualMachineScaleSetVMExtension{
	// ...
}


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

Example Usage: VirtualMachineScaleSetVMExtensionsClient.Delete

ctx := context.TODO()
id := virtualmachinescalesetvmextensions.NewVirtualMachineExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetValue", "instanceIdValue", "extensionValue")

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

Example Usage: VirtualMachineScaleSetVMExtensionsClient.Get

ctx := context.TODO()
id := virtualmachinescalesetvmextensions.NewVirtualMachineExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetValue", "instanceIdValue", "extensionValue")

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

Example Usage: VirtualMachineScaleSetVMExtensionsClient.List

ctx := context.TODO()
id := virtualmachinescalesetvmextensions.NewVirtualMachineScaleSetVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetValue", "instanceIdValue")

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

Example Usage: VirtualMachineScaleSetVMExtensionsClient.Update

ctx := context.TODO()
id := virtualmachinescalesetvmextensions.NewVirtualMachineExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineScaleSetValue", "instanceIdValue", "extensionValue")

payload := virtualmachinescalesetvmextensions.VirtualMachineScaleSetVMExtensionUpdate{
	// ...
}


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 PossibleValuesForStatusLevelTypes

func PossibleValuesForStatusLevelTypes() []string

func ValidateVirtualMachineExtensionID

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

ValidateVirtualMachineExtensionID checks that 'input' can be parsed as a Virtual Machine Extension ID

func ValidateVirtualMachineScaleSetVirtualMachineID

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

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

Types

type CreateOrUpdateOperationResponse

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

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 added in v0.20230808.1103829

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

func (GetOperationOptions) ToOData added in v0.20230808.1103829

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

func (GetOperationOptions) ToQuery added in v0.20230808.1103829

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

type GetOperationResponse

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

type InstanceViewStatus

type InstanceViewStatus struct {
	Code          *string           `json:"code,omitempty"`
	DisplayStatus *string           `json:"displayStatus,omitempty"`
	Level         *StatusLevelTypes `json:"level,omitempty"`
	Message       *string           `json:"message,omitempty"`
	Time          *string           `json:"time,omitempty"`
}

func (*InstanceViewStatus) GetTimeAsTime

func (o *InstanceViewStatus) GetTimeAsTime() (*time.Time, error)

func (*InstanceViewStatus) SetTimeAsTime

func (o *InstanceViewStatus) SetTimeAsTime(input time.Time)

type KeyVaultSecretReference

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

type ListOperationOptions

type ListOperationOptions struct {
	Expand *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230808.1103829

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

func (ListOperationOptions) ToOData added in v0.20230808.1103829

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

func (ListOperationOptions) ToQuery added in v0.20230808.1103829

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualMachineScaleSetVMExtensionsListResult
}

type StatusLevelTypes

type StatusLevelTypes string
const (
	StatusLevelTypesError   StatusLevelTypes = "Error"
	StatusLevelTypesInfo    StatusLevelTypes = "Info"
	StatusLevelTypesWarning StatusLevelTypes = "Warning"
)

func (*StatusLevelTypes) UnmarshalJSON added in v0.20230808.1103829

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

type SubResource

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

type UpdateOperationResponse

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

type VirtualMachineExtensionId

type VirtualMachineExtensionId struct {
	SubscriptionId             string
	ResourceGroupName          string
	VirtualMachineScaleSetName string
	InstanceId                 string
	ExtensionName              string
}

VirtualMachineExtensionId is a struct representing the Resource ID for a Virtual Machine Extension

func NewVirtualMachineExtensionID

func NewVirtualMachineExtensionID(subscriptionId string, resourceGroupName string, virtualMachineScaleSetName string, instanceId string, extensionName string) VirtualMachineExtensionId

NewVirtualMachineExtensionID returns a new VirtualMachineExtensionId struct

func ParseVirtualMachineExtensionID

func ParseVirtualMachineExtensionID(input string) (*VirtualMachineExtensionId, error)

ParseVirtualMachineExtensionID parses 'input' into a VirtualMachineExtensionId

func ParseVirtualMachineExtensionIDInsensitively

func ParseVirtualMachineExtensionIDInsensitively(input string) (*VirtualMachineExtensionId, error)

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

func (VirtualMachineExtensionId) ID

ID returns the formatted Virtual Machine Extension ID

func (VirtualMachineExtensionId) Segments

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

func (VirtualMachineExtensionId) String

func (id VirtualMachineExtensionId) String() string

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

type VirtualMachineExtensionInstanceView

type VirtualMachineExtensionInstanceView struct {
	Name               *string               `json:"name,omitempty"`
	Statuses           *[]InstanceViewStatus `json:"statuses,omitempty"`
	Substatuses        *[]InstanceViewStatus `json:"substatuses,omitempty"`
	Type               *string               `json:"type,omitempty"`
	TypeHandlerVersion *string               `json:"typeHandlerVersion,omitempty"`
}

type VirtualMachineExtensionProperties

type VirtualMachineExtensionProperties struct {
	AutoUpgradeMinorVersion       *bool                                `json:"autoUpgradeMinorVersion,omitempty"`
	EnableAutomaticUpgrade        *bool                                `json:"enableAutomaticUpgrade,omitempty"`
	ForceUpdateTag                *string                              `json:"forceUpdateTag,omitempty"`
	InstanceView                  *VirtualMachineExtensionInstanceView `json:"instanceView,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 VirtualMachineExtensionUpdateProperties

type VirtualMachineExtensionUpdateProperties 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"`
	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 VirtualMachineScaleSetVMExtension

type VirtualMachineScaleSetVMExtension struct {
	Id         *string                            `json:"id,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *VirtualMachineExtensionProperties `json:"properties,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type VirtualMachineScaleSetVMExtensionUpdate

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

type VirtualMachineScaleSetVMExtensionsClient

type VirtualMachineScaleSetVMExtensionsClient struct {
	Client *resourcemanager.Client
}

func NewVirtualMachineScaleSetVMExtensionsClientWithBaseURI

func NewVirtualMachineScaleSetVMExtensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualMachineScaleSetVMExtensionsClient, error)

func (VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdate

CreateOrUpdate ...

func (VirtualMachineScaleSetVMExtensionsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualMachineScaleSetVMExtensionsClient) Delete

Delete ...

func (VirtualMachineScaleSetVMExtensionsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualMachineScaleSetVMExtensionsClient) Get

Get ...

func (VirtualMachineScaleSetVMExtensionsClient) List

List ...

func (VirtualMachineScaleSetVMExtensionsClient) Update

Update ...

func (VirtualMachineScaleSetVMExtensionsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type VirtualMachineScaleSetVMExtensionsListResult

type VirtualMachineScaleSetVMExtensionsListResult struct {
	Value *[]VirtualMachineScaleSetVMExtension `json:"value,omitempty"`
}

type VirtualMachineScaleSetVirtualMachineId

type VirtualMachineScaleSetVirtualMachineId struct {
	SubscriptionId             string
	ResourceGroupName          string
	VirtualMachineScaleSetName string
	InstanceId                 string
}

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

func NewVirtualMachineScaleSetVirtualMachineID

func NewVirtualMachineScaleSetVirtualMachineID(subscriptionId string, resourceGroupName string, virtualMachineScaleSetName string, instanceId string) VirtualMachineScaleSetVirtualMachineId

NewVirtualMachineScaleSetVirtualMachineID returns a new VirtualMachineScaleSetVirtualMachineId struct

func ParseVirtualMachineScaleSetVirtualMachineID

func ParseVirtualMachineScaleSetVirtualMachineID(input string) (*VirtualMachineScaleSetVirtualMachineId, error)

ParseVirtualMachineScaleSetVirtualMachineID parses 'input' into a VirtualMachineScaleSetVirtualMachineId

func ParseVirtualMachineScaleSetVirtualMachineIDInsensitively

func ParseVirtualMachineScaleSetVirtualMachineIDInsensitively(input string) (*VirtualMachineScaleSetVirtualMachineId, error)

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

func (VirtualMachineScaleSetVirtualMachineId) ID

ID returns the formatted Virtual Machine Scale Set Virtual Machine ID

func (VirtualMachineScaleSetVirtualMachineId) Segments

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

func (VirtualMachineScaleSetVirtualMachineId) String

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL