vmmservers

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/systemcentervirtualmachinemanager/2024-06-01/vmmservers Documentation

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

Client Initialization

client := vmmservers.NewVMmServersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VMmServersClient.CreateOrUpdate

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

payload := vmmservers.VMmServer{
	// ...
}


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

Example Usage: VMmServersClient.Delete

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

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

Example Usage: VMmServersClient.Get

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

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: VMmServersClient.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: VMmServersClient.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: VMmServersClient.Update

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

payload := vmmservers.VMmServerTagsUpdate{
	// ...
}


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 PossibleValuesForForceDelete 

func PossibleValuesForForceDelete() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateVMmServerID 

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

ValidateVMmServerID checks that 'input' can be parsed as a V Mm Server ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	Force *ForceDelete
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

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

type ExtendedLocation 

type ExtendedLocation struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ForceDelete 

type ForceDelete string
const (
	ForceDeleteFalse ForceDelete = "false"
	ForceDeleteTrue  ForceDelete = "true"
)

func (*ForceDelete) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

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        *[]VMmServer
}

type ListBySubscriptionCompleteResult 

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

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        *[]VMmServer
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreated      ProvisioningState = "Created"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

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

type VMmCredential 

type VMmCredential struct {
	Password *string `json:"password,omitempty"`
	Username *string `json:"username,omitempty"`
}

type VMmServer 

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

type VMmServerId 

type VMmServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	VmmServerName     string
}

VMmServerId is a struct representing the Resource ID for a V Mm Server

func NewVMmServerID 

func NewVMmServerID(subscriptionId string, resourceGroupName string, vmmServerName string) VMmServerId

NewVMmServerID returns a new VMmServerId struct

func ParseVMmServerID 

func ParseVMmServerID(input string) (*VMmServerId, error)

ParseVMmServerID parses 'input' into a VMmServerId

func ParseVMmServerIDInsensitively 

func ParseVMmServerIDInsensitively(input string) (*VMmServerId, error)

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

func (*VMmServerId) FromParseResult 

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

func (VMmServerId) ID 

func (id VMmServerId) ID() string

ID returns the formatted V Mm Server ID

func (VMmServerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this V Mm Server ID

func (VMmServerId) String 

func (id VMmServerId) String() string

String returns a human-readable description of this V Mm Server ID

type VMmServerOperationPredicate 

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

func (VMmServerOperationPredicate) Matches 

func (p VMmServerOperationPredicate) Matches(input VMmServer) bool

type VMmServerProperties 

type VMmServerProperties struct {
	ConnectionStatus  *string            `json:"connectionStatus,omitempty"`
	Credentials       *VMmCredential     `json:"credentials,omitempty"`
	ErrorMessage      *string            `json:"errorMessage,omitempty"`
	Fqdn              string             `json:"fqdn"`
	Port              *int64             `json:"port,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	Uuid              *string            `json:"uuid,omitempty"`
	Version           *string            `json:"version,omitempty"`
}

type VMmServerTagsUpdate 

type VMmServerTagsUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type VMmServersClient 

type VMmServersClient struct {
	Client *resourcemanager.Client
}

func NewVMmServersClientWithBaseURI 

func NewVMmServersClientWithBaseURI(sdkApi sdkEnv.Api) (*VMmServersClient, error)

func (VMmServersClient) CreateOrUpdate 

func (c VMmServersClient) CreateOrUpdate(ctx context.Context, id VMmServerId, input VMmServer) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VMmServersClient) CreateOrUpdateThenPoll 

func (c VMmServersClient) CreateOrUpdateThenPoll(ctx context.Context, id VMmServerId, input VMmServer) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VMmServersClient) Delete 

func (c VMmServersClient) Delete(ctx context.Context, id VMmServerId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (VMmServersClient) DeleteThenPoll 

func (c VMmServersClient) DeleteThenPoll(ctx context.Context, id VMmServerId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (VMmServersClient) Get 

func (c VMmServersClient) Get(ctx context.Context, id VMmServerId) (result GetOperationResponse, err error)

Get ...

func (VMmServersClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (VMmServersClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (VMmServersClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VMmServersClient) ListBySubscription 

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

ListBySubscription ...

func (VMmServersClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (VMmServersClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VMmServersClient) Update 

func (c VMmServersClient) Update(ctx context.Context, id VMmServerId, input VMmServerTagsUpdate) (result UpdateOperationResponse, err error)

Update ...

func (VMmServersClient) UpdateThenPoll 

func (c VMmServersClient) UpdateThenPoll(ctx context.Context, id VMmServerId, input VMmServerTagsUpdate) error

UpdateThenPoll performs Update then polls until it's completed

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.