standbyvirtualmachines

package
v0.20250115.1141151 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2025 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The standbyvirtualmachines 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-sdk/resource-manager/standbypool/2024-03-01/standbyvirtualmachines"

Client Initialization

client := standbyvirtualmachines.NewStandbyVirtualMachinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StandbyVirtualMachinesClient.Get

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

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: StandbyVirtualMachinesClient.ListByStandbyVirtualMachinePoolResource

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateStandbyVirtualMachineID 

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

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

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 GetOperationResponse 

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

type ListByStandbyVirtualMachinePoolResourceCompleteResult 

type ListByStandbyVirtualMachinePoolResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StandbyVirtualMachineResource
}

type ListByStandbyVirtualMachinePoolResourceCustomPager 

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

type ListByStandbyVirtualMachinePoolResourceOperationResponse 

type ListByStandbyVirtualMachinePoolResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StandbyVirtualMachineResource
}

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 StandbyVirtualMachineId 

type StandbyVirtualMachineId struct {
	SubscriptionId                string
	ResourceGroupName             string
	StandbyVirtualMachinePoolName string
	StandbyVirtualMachineName     string
}

StandbyVirtualMachineId is a struct representing the Resource ID for a Standby Virtual Machine

func NewStandbyVirtualMachineID 

func NewStandbyVirtualMachineID(subscriptionId string, resourceGroupName string, standbyVirtualMachinePoolName string, standbyVirtualMachineName string) StandbyVirtualMachineId

NewStandbyVirtualMachineID returns a new StandbyVirtualMachineId struct

func ParseStandbyVirtualMachineID 

func ParseStandbyVirtualMachineID(input string) (*StandbyVirtualMachineId, error)

ParseStandbyVirtualMachineID parses 'input' into a StandbyVirtualMachineId

func ParseStandbyVirtualMachineIDInsensitively 

func ParseStandbyVirtualMachineIDInsensitively(input string) (*StandbyVirtualMachineId, error)

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

func (*StandbyVirtualMachineId) FromParseResult 

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

func (StandbyVirtualMachineId) ID 

func (id StandbyVirtualMachineId) ID() string

ID returns the formatted Standby Virtual Machine ID

func (StandbyVirtualMachineId) Segments 

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

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

func (StandbyVirtualMachineId) String 

func (id StandbyVirtualMachineId) String() string

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

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 StandbyVirtualMachineResource 

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

type StandbyVirtualMachineResourceOperationPredicate 

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

func (StandbyVirtualMachineResourceOperationPredicate) Matches 

func (p StandbyVirtualMachineResourceOperationPredicate) Matches(input StandbyVirtualMachineResource) bool

type StandbyVirtualMachineResourceProperties 

type StandbyVirtualMachineResourceProperties struct {
	ProvisioningState        *ProvisioningState `json:"provisioningState,omitempty"`
	VirtualMachineResourceId string             `json:"virtualMachineResourceId"`
}

type StandbyVirtualMachinesClient 

type StandbyVirtualMachinesClient struct {
	Client *resourcemanager.Client
}

func NewStandbyVirtualMachinesClientWithBaseURI 

func NewStandbyVirtualMachinesClientWithBaseURI(sdkApi sdkEnv.Api) (*StandbyVirtualMachinesClient, error)

func (StandbyVirtualMachinesClient) Get 

func (c StandbyVirtualMachinesClient) Get(ctx context.Context, id StandbyVirtualMachineId) (result GetOperationResponse, err error)

Get ...

func (StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResource 

func (c StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResource(ctx context.Context, id StandbyVirtualMachinePoolId) (result ListByStandbyVirtualMachinePoolResourceOperationResponse, err error)

ListByStandbyVirtualMachinePoolResource ...

func (StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResourceComplete 

func (c StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResourceComplete(ctx context.Context, id StandbyVirtualMachinePoolId) (ListByStandbyVirtualMachinePoolResourceCompleteResult, error)

ListByStandbyVirtualMachinePoolResourceComplete retrieves all the results into a single object

func (StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResourceCompleteMatchingPredicate 

func (c StandbyVirtualMachinesClient) ListByStandbyVirtualMachinePoolResourceCompleteMatchingPredicate(ctx context.Context, id StandbyVirtualMachinePoolId, predicate StandbyVirtualMachineResourceOperationPredicate) (result ListByStandbyVirtualMachinePoolResourceCompleteResult, err error)

ListByStandbyVirtualMachinePoolResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.