workloadnetworkvirtualmachines

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/workloadnetworkvirtualmachines Documentation

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

Client Initialization

client := workloadnetworkvirtualmachines.NewWorkloadNetworkVirtualMachinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkloadNetworkVirtualMachinesClient.WorkloadNetworksGetVirtualMachine

ctx := context.TODO()
id := workloadnetworkvirtualmachines.NewDefaultVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "virtualMachineId")

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

Example Usage: WorkloadNetworkVirtualMachinesClient.WorkloadNetworksListVirtualMachines

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

// alternatively `client.WorkloadNetworksListVirtualMachines(ctx, id)` can be used to do batched pagination
items, err := client.WorkloadNetworksListVirtualMachinesComplete(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 PossibleValuesForVMTypeEnum 

func PossibleValuesForVMTypeEnum() []string

func PossibleValuesForWorkloadNetworkProvisioningState 

func PossibleValuesForWorkloadNetworkProvisioningState() []string

func ValidateDefaultVirtualMachineID 

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

ValidateDefaultVirtualMachineID checks that 'input' can be parsed as a Default Virtual Machine ID

func ValidatePrivateCloudID 

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

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID

Types

type DefaultVirtualMachineId 

type DefaultVirtualMachineId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
	VirtualMachineId  string
}

DefaultVirtualMachineId is a struct representing the Resource ID for a Default Virtual Machine

func NewDefaultVirtualMachineID 

func NewDefaultVirtualMachineID(subscriptionId string, resourceGroupName string, privateCloudName string, virtualMachineId string) DefaultVirtualMachineId

NewDefaultVirtualMachineID returns a new DefaultVirtualMachineId struct

func ParseDefaultVirtualMachineID 

func ParseDefaultVirtualMachineID(input string) (*DefaultVirtualMachineId, error)

ParseDefaultVirtualMachineID parses 'input' into a DefaultVirtualMachineId

func ParseDefaultVirtualMachineIDInsensitively 

func ParseDefaultVirtualMachineIDInsensitively(input string) (*DefaultVirtualMachineId, error)

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

func (*DefaultVirtualMachineId) FromParseResult 

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

func (DefaultVirtualMachineId) ID 

func (id DefaultVirtualMachineId) ID() string

ID returns the formatted Default Virtual Machine ID

func (DefaultVirtualMachineId) Segments 

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

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

func (DefaultVirtualMachineId) String 

func (id DefaultVirtualMachineId) String() string

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

type PrivateCloudId 

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID 

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID 

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively 

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

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

func (*PrivateCloudId) FromParseResult 

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

func (PrivateCloudId) ID 

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String 

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud ID

type VMTypeEnum 

type VMTypeEnum string
const (
	VMTypeEnumEDGE    VMTypeEnum = "EDGE"
	VMTypeEnumREGULAR VMTypeEnum = "REGULAR"
	VMTypeEnumSERVICE VMTypeEnum = "SERVICE"
)

func (*VMTypeEnum) UnmarshalJSON 

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

type WorkloadNetworkProvisioningState 

type WorkloadNetworkProvisioningState string
const (
	WorkloadNetworkProvisioningStateBuilding  WorkloadNetworkProvisioningState = "Building"
	WorkloadNetworkProvisioningStateCanceled  WorkloadNetworkProvisioningState = "Canceled"
	WorkloadNetworkProvisioningStateDeleting  WorkloadNetworkProvisioningState = "Deleting"
	WorkloadNetworkProvisioningStateFailed    WorkloadNetworkProvisioningState = "Failed"
	WorkloadNetworkProvisioningStateSucceeded WorkloadNetworkProvisioningState = "Succeeded"
	WorkloadNetworkProvisioningStateUpdating  WorkloadNetworkProvisioningState = "Updating"
)

func (*WorkloadNetworkProvisioningState) UnmarshalJSON 

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

type WorkloadNetworkVirtualMachine 

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

type WorkloadNetworkVirtualMachineOperationPredicate 

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

func (WorkloadNetworkVirtualMachineOperationPredicate) Matches 

func (p WorkloadNetworkVirtualMachineOperationPredicate) Matches(input WorkloadNetworkVirtualMachine) bool

type WorkloadNetworkVirtualMachineProperties 

type WorkloadNetworkVirtualMachineProperties struct {
	DisplayName       *string                           `json:"displayName,omitempty"`
	ProvisioningState *WorkloadNetworkProvisioningState `json:"provisioningState,omitempty"`
	VMType            *VMTypeEnum                       `json:"vmType,omitempty"`
}

type WorkloadNetworkVirtualMachinesClient 

type WorkloadNetworkVirtualMachinesClient struct {
	Client *resourcemanager.Client
}

func NewWorkloadNetworkVirtualMachinesClientWithBaseURI 

func NewWorkloadNetworkVirtualMachinesClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkloadNetworkVirtualMachinesClient, error)

func (WorkloadNetworkVirtualMachinesClient) WorkloadNetworksGetVirtualMachine 

func (c WorkloadNetworkVirtualMachinesClient) WorkloadNetworksGetVirtualMachine(ctx context.Context, id DefaultVirtualMachineId) (result WorkloadNetworksGetVirtualMachineOperationResponse, err error)

WorkloadNetworksGetVirtualMachine ...

func (WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachines 

func (c WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachines(ctx context.Context, id PrivateCloudId) (result WorkloadNetworksListVirtualMachinesOperationResponse, err error)

WorkloadNetworksListVirtualMachines ...

func (WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachinesComplete 

func (c WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachinesComplete(ctx context.Context, id PrivateCloudId) (WorkloadNetworksListVirtualMachinesCompleteResult, error)

WorkloadNetworksListVirtualMachinesComplete retrieves all the results into a single object

func (WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachinesCompleteMatchingPredicate 

func (c WorkloadNetworkVirtualMachinesClient) WorkloadNetworksListVirtualMachinesCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate WorkloadNetworkVirtualMachineOperationPredicate) (result WorkloadNetworksListVirtualMachinesCompleteResult, err error)

WorkloadNetworksListVirtualMachinesCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkloadNetworksGetVirtualMachineOperationResponse 

type WorkloadNetworksGetVirtualMachineOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkloadNetworkVirtualMachine
}

type WorkloadNetworksListVirtualMachinesCompleteResult 

type WorkloadNetworksListVirtualMachinesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkloadNetworkVirtualMachine
}

type WorkloadNetworksListVirtualMachinesCustomPager added in v0.20240628.1153531 

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

type WorkloadNetworksListVirtualMachinesOperationResponse 

type WorkloadNetworksListVirtualMachinesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkloadNetworkVirtualMachine
}

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.