guestagents

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

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

The guestagents 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/guestagents"

Client Initialization

client := guestagents.NewGuestAgentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GuestAgentsClient.Create

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

payload := guestagents.GuestAgent{
	// ...
}


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

Example Usage: GuestAgentsClient.Delete

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: GuestAgentsClient.Get

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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: GuestAgentsClient.ListByVirtualMachineInstance

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

func PossibleValuesForProvisioningAction() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GuestAgent
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type GuestAgent 

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

type GuestAgentOperationPredicate 

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

func (GuestAgentOperationPredicate) Matches 

func (p GuestAgentOperationPredicate) Matches(input GuestAgent) bool

type GuestAgentProperties 

type GuestAgentProperties struct {
	Credentials                *GuestCredential        `json:"credentials,omitempty"`
	CustomResourceName         *string                 `json:"customResourceName,omitempty"`
	HTTPProxyConfig            *HTTPProxyConfiguration `json:"httpProxyConfig,omitempty"`
	PrivateLinkScopeResourceId *string                 `json:"privateLinkScopeResourceId,omitempty"`
	ProvisioningAction         *ProvisioningAction     `json:"provisioningAction,omitempty"`
	ProvisioningState          *ProvisioningState      `json:"provisioningState,omitempty"`
	Status                     *string                 `json:"status,omitempty"`
	Uuid                       *string                 `json:"uuid,omitempty"`
}

type GuestAgentsClient 

type GuestAgentsClient struct {
	Client *resourcemanager.Client
}

func NewGuestAgentsClientWithBaseURI 

func NewGuestAgentsClientWithBaseURI(sdkApi sdkEnv.Api) (*GuestAgentsClient, error)

func (GuestAgentsClient) Create 

func (c GuestAgentsClient) Create(ctx context.Context, id commonids.ScopeId, input GuestAgent) (result CreateOperationResponse, err error)

Create ...

func (GuestAgentsClient) CreateThenPoll 

func (c GuestAgentsClient) CreateThenPoll(ctx context.Context, id commonids.ScopeId, input GuestAgent) error

CreateThenPoll performs Create then polls until it's completed

func (GuestAgentsClient) Delete 

func (c GuestAgentsClient) Delete(ctx context.Context, id commonids.ScopeId) (result DeleteOperationResponse, err error)

Delete ...

func (GuestAgentsClient) Get 

func (c GuestAgentsClient) Get(ctx context.Context, id commonids.ScopeId) (result GetOperationResponse, err error)

Get ...

func (GuestAgentsClient) ListByVirtualMachineInstance 

func (c GuestAgentsClient) ListByVirtualMachineInstance(ctx context.Context, id commonids.ScopeId) (result ListByVirtualMachineInstanceOperationResponse, err error)

ListByVirtualMachineInstance ...

func (GuestAgentsClient) ListByVirtualMachineInstanceComplete 

func (c GuestAgentsClient) ListByVirtualMachineInstanceComplete(ctx context.Context, id commonids.ScopeId) (ListByVirtualMachineInstanceCompleteResult, error)

ListByVirtualMachineInstanceComplete retrieves all the results into a single object

func (GuestAgentsClient) ListByVirtualMachineInstanceCompleteMatchingPredicate 

func (c GuestAgentsClient) ListByVirtualMachineInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate GuestAgentOperationPredicate) (result ListByVirtualMachineInstanceCompleteResult, err error)

ListByVirtualMachineInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GuestCredential 

type GuestCredential struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

type HTTPProxyConfiguration 

type HTTPProxyConfiguration struct {
	HTTPSProxy *string `json:"httpsProxy,omitempty"`
}

type ListByVirtualMachineInstanceCompleteResult 

type ListByVirtualMachineInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GuestAgent
}

type ListByVirtualMachineInstanceCustomPager 

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

type ListByVirtualMachineInstanceOperationResponse 

type ListByVirtualMachineInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GuestAgent
}

type ProvisioningAction 

type ProvisioningAction string
const (
	ProvisioningActionInstall   ProvisioningAction = "install"
	ProvisioningActionRepair    ProvisioningAction = "repair"
	ProvisioningActionUninstall ProvisioningAction = "uninstall"
)

func (*ProvisioningAction) UnmarshalJSON 

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

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

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.