github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-01/virtualmachinescalesets Documentation

The virtualmachinescalesets SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2022-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-01/virtualmachinescalesets"

Client Initialization

client := virtualmachinescalesets.NewVirtualMachineScaleSetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualMachineScaleSetsClient.ConvertToSinglePlacementGroup

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

payload := virtualmachinescalesets.VMScaleSetConvertToSinglePlacementGroupInput{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.CreateOrUpdate

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

payload := virtualmachinescalesets.VirtualMachineScaleSet{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Deallocate

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Delete

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

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

Example Usage: VirtualMachineScaleSetsClient.DeleteInstances

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceRequiredIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.ForceRecoveryServiceFabricPlatformUpdateDomainWalk

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

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

Example Usage: VirtualMachineScaleSetsClient.Get

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

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

Example Usage: VirtualMachineScaleSetsClient.GetInstanceView

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

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

Example Usage: VirtualMachineScaleSetsClient.GetOSUpgradeHistory

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

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

Example Usage: VirtualMachineScaleSetsClient.List

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

// 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: VirtualMachineScaleSetsClient.ListAll

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: VirtualMachineScaleSetsClient.ListByLocation

ctx := context.TODO()
id := virtualmachinescalesets.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Example Usage: VirtualMachineScaleSetsClient.ListSkus

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

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

Example Usage: VirtualMachineScaleSetsClient.PerformMaintenance

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.PowerOff

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Redeploy

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Reimage

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

payload := virtualmachinescalesets.VirtualMachineScaleSetReimageParameters{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.ReimageAll

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Restart

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.SetOrchestrationServiceState

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

payload := virtualmachinescalesets.OrchestrationServiceStateInput{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Start

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceIDs{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.Update

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

payload := virtualmachinescalesets.VirtualMachineScaleSetUpdate{
	// ...
}


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

Example Usage: VirtualMachineScaleSetsClient.UpdateInstances

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

payload := virtualmachinescalesets.VirtualMachineScaleSetVMInstanceRequiredIDs{
	// ...
}


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