vmmservers

package
v0.20240627.1143641 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/systemcentervirtualmachinemanager/2023-10-07/vmmservers Documentation

The vmmservers SDK allows for interaction with the Azure Resource Manager Service systemcentervirtualmachinemanager (API Version 2023-10-07).

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/2023-10-07/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", "vmmServerValue")

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", "vmmServerValue")

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", "vmmServerValue")

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", "vmmServerValue")

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 added in v0.20240604.1114748

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

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 added in v0.20240604.1114748

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

func (*ForceDelete) UnmarshalJSON added in v0.20240604.1114748

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 ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

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

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 added in v0.20240604.1114748

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

type VMmServer added in v0.20240604.1114748

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 added in v0.20240604.1114748

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

func (VMmServerOperationPredicate) Matches added in v0.20240604.1114748

func (p VMmServerOperationPredicate) Matches(input VMmServer) bool

type VMmServerProperties added in v0.20240604.1114748

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 added in v0.20240604.1114748

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

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

Get ...

func (VMmServersClient) ListByResourceGroup

ListByResourceGroup ...

func (VMmServersClient) ListByResourceGroupComplete

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

ListBySubscription ...

func (VMmServersClient) ListBySubscriptionComplete

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL