standbyvirtualmachinepools

package
v0.20241128.1084944 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/standbypool/2024-03-01/standbyvirtualmachinepools Documentation

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

Client Initialization

client := standbyvirtualmachinepools.NewStandbyVirtualMachinePoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StandbyVirtualMachinePoolsClient.CreateOrUpdate

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

payload := standbyvirtualmachinepools.StandbyVirtualMachinePoolResource{
	// ...
}


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

Example Usage: StandbyVirtualMachinePoolsClient.Delete

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

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

Example Usage: StandbyVirtualMachinePoolsClient.Get

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

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

Example Usage: StandbyVirtualMachinePoolsClient.ListByResourceGroup

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

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

Example Usage: StandbyVirtualMachinePoolsClient.ListBySubscription

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

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

Example Usage: StandbyVirtualMachinePoolsClient.Update

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

payload := standbyvirtualmachinepools.StandbyVirtualMachinePoolResourceUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForVirtualMachineState 

func PossibleValuesForVirtualMachineState() []string

func ValidateStandbyVirtualMachinePoolID 

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

ValidateStandbyVirtualMachinePoolID checks that 'input' can be parsed as a Standby Virtual Machine Pool ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StandbyVirtualMachinePoolResource
}

type ListByResourceGroupCustomPager 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StandbyVirtualMachinePoolResource
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StandbyVirtualMachinePoolResource
}

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StandbyVirtualMachinePoolResource
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type StandbyVirtualMachinePoolElasticityProfile 

type StandbyVirtualMachinePoolElasticityProfile struct {
	MaxReadyCapacity int64  `json:"maxReadyCapacity"`
	MinReadyCapacity *int64 `json:"minReadyCapacity,omitempty"`
}

type StandbyVirtualMachinePoolId 

type StandbyVirtualMachinePoolId struct {
	SubscriptionId                string
	ResourceGroupName             string
	StandbyVirtualMachinePoolName string
}

StandbyVirtualMachinePoolId is a struct representing the Resource ID for a Standby Virtual Machine Pool

func NewStandbyVirtualMachinePoolID 

func NewStandbyVirtualMachinePoolID(subscriptionId string, resourceGroupName string, standbyVirtualMachinePoolName string) StandbyVirtualMachinePoolId

NewStandbyVirtualMachinePoolID returns a new StandbyVirtualMachinePoolId struct

func ParseStandbyVirtualMachinePoolID 

func ParseStandbyVirtualMachinePoolID(input string) (*StandbyVirtualMachinePoolId, error)

ParseStandbyVirtualMachinePoolID parses 'input' into a StandbyVirtualMachinePoolId

func ParseStandbyVirtualMachinePoolIDInsensitively 

func ParseStandbyVirtualMachinePoolIDInsensitively(input string) (*StandbyVirtualMachinePoolId, error)

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

func (*StandbyVirtualMachinePoolId) FromParseResult 

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

func (StandbyVirtualMachinePoolId) ID 

func (id StandbyVirtualMachinePoolId) ID() string

ID returns the formatted Standby Virtual Machine Pool ID

func (StandbyVirtualMachinePoolId) Segments 

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

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

func (StandbyVirtualMachinePoolId) String 

func (id StandbyVirtualMachinePoolId) String() string

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

type StandbyVirtualMachinePoolResource 

type StandbyVirtualMachinePoolResource struct {
	Id         *string                                      `json:"id,omitempty"`
	Location   string                                       `json:"location"`
	Name       *string                                      `json:"name,omitempty"`
	Properties *StandbyVirtualMachinePoolResourceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                       `json:"systemData,omitempty"`
	Tags       *map[string]string                           `json:"tags,omitempty"`
	Type       *string                                      `json:"type,omitempty"`
}

type StandbyVirtualMachinePoolResourceOperationPredicate 

type StandbyVirtualMachinePoolResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (StandbyVirtualMachinePoolResourceOperationPredicate) Matches 

func (p StandbyVirtualMachinePoolResourceOperationPredicate) Matches(input StandbyVirtualMachinePoolResource) bool

type StandbyVirtualMachinePoolResourceProperties 

type StandbyVirtualMachinePoolResourceProperties struct {
	AttachedVirtualMachineScaleSetId *string                                     `json:"attachedVirtualMachineScaleSetId,omitempty"`
	ElasticityProfile                *StandbyVirtualMachinePoolElasticityProfile `json:"elasticityProfile,omitempty"`
	ProvisioningState                *ProvisioningState                          `json:"provisioningState,omitempty"`
	VirtualMachineState              VirtualMachineState                         `json:"virtualMachineState"`
}

type StandbyVirtualMachinePoolResourceUpdate 

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

type StandbyVirtualMachinePoolResourceUpdateProperties 

type StandbyVirtualMachinePoolResourceUpdateProperties struct {
	AttachedVirtualMachineScaleSetId *string                                     `json:"attachedVirtualMachineScaleSetId,omitempty"`
	ElasticityProfile                *StandbyVirtualMachinePoolElasticityProfile `json:"elasticityProfile,omitempty"`
	VirtualMachineState              *VirtualMachineState                        `json:"virtualMachineState,omitempty"`
}

type StandbyVirtualMachinePoolsClient 

type StandbyVirtualMachinePoolsClient struct {
	Client *resourcemanager.Client
}

func NewStandbyVirtualMachinePoolsClientWithBaseURI 

func NewStandbyVirtualMachinePoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*StandbyVirtualMachinePoolsClient, error)

func (StandbyVirtualMachinePoolsClient) CreateOrUpdate 

func (c StandbyVirtualMachinePoolsClient) CreateOrUpdate(ctx context.Context, id StandbyVirtualMachinePoolId, input StandbyVirtualMachinePoolResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (StandbyVirtualMachinePoolsClient) CreateOrUpdateThenPoll 

func (c StandbyVirtualMachinePoolsClient) CreateOrUpdateThenPoll(ctx context.Context, id StandbyVirtualMachinePoolId, input StandbyVirtualMachinePoolResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (StandbyVirtualMachinePoolsClient) Delete 

func (c StandbyVirtualMachinePoolsClient) Delete(ctx context.Context, id StandbyVirtualMachinePoolId) (result DeleteOperationResponse, err error)

Delete ...

func (StandbyVirtualMachinePoolsClient) DeleteThenPoll 

func (c StandbyVirtualMachinePoolsClient) DeleteThenPoll(ctx context.Context, id StandbyVirtualMachinePoolId) error

DeleteThenPoll performs Delete then polls until it's completed

func (StandbyVirtualMachinePoolsClient) Get 

func (c StandbyVirtualMachinePoolsClient) Get(ctx context.Context, id StandbyVirtualMachinePoolId) (result GetOperationResponse, err error)

Get ...

func (StandbyVirtualMachinePoolsClient) ListByResourceGroup 

func (c StandbyVirtualMachinePoolsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (StandbyVirtualMachinePoolsClient) ListByResourceGroupComplete 

func (c StandbyVirtualMachinePoolsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (StandbyVirtualMachinePoolsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c StandbyVirtualMachinePoolsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate StandbyVirtualMachinePoolResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StandbyVirtualMachinePoolsClient) ListBySubscription 

func (c StandbyVirtualMachinePoolsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (StandbyVirtualMachinePoolsClient) ListBySubscriptionComplete 

func (c StandbyVirtualMachinePoolsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (StandbyVirtualMachinePoolsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c StandbyVirtualMachinePoolsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate StandbyVirtualMachinePoolResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StandbyVirtualMachinePoolsClient) Update 

func (c StandbyVirtualMachinePoolsClient) Update(ctx context.Context, id StandbyVirtualMachinePoolId, input StandbyVirtualMachinePoolResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StandbyVirtualMachinePoolResource
}

type VirtualMachineState 

type VirtualMachineState string
const (
	VirtualMachineStateDeallocated VirtualMachineState = "Deallocated"
	VirtualMachineStateRunning     VirtualMachineState = "Running"
)

func (*VirtualMachineState) UnmarshalJSON 

func (s *VirtualMachineState) 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.