virtualmachines

package
v0.20231213.1160254 Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/devtestlab/2018-09-15/virtualmachines Documentation

The virtualmachines SDK allows for interaction with the Azure Resource Manager Service devtestlab (API Version 2018-09-15).

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/devtestlab/2018-09-15/virtualmachines"

Client Initialization

client := virtualmachines.NewVirtualMachinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualMachinesClient.AddDataDisk

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.DataDiskProperties{
	// ...
}


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

Example Usage: VirtualMachinesClient.ApplyArtifacts

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.ApplyArtifactsRequest{
	// ...
}


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

Example Usage: VirtualMachinesClient.Claim

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.CreateOrUpdate

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.LabVirtualMachine{
	// ...
}


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

Example Usage: VirtualMachinesClient.Delete

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.DetachDataDisk

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.DetachDataDiskProperties{
	// ...
}


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

Example Usage: VirtualMachinesClient.Get

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.GetRdpFileContents

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.List

ctx := context.TODO()
id := virtualmachines.NewLabID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue")

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

Example Usage: VirtualMachinesClient.ListApplicableSchedules

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.Redeploy

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.Resize

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.ResizeLabVirtualMachineProperties{
	// ...
}


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

Example Usage: VirtualMachinesClient.Restart

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.Start

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.Stop

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.TransferDisks

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.UnClaim

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

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

Example Usage: VirtualMachinesClient.Update

ctx := context.TODO()
id := virtualmachines.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "virtualMachineValue")

payload := virtualmachines.UpdateResource{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEnableStatus 

func PossibleValuesForEnableStatus() []string

func PossibleValuesForHostCachingOptions 

func PossibleValuesForHostCachingOptions() []string

func PossibleValuesForStorageType 

func PossibleValuesForStorageType() []string

func PossibleValuesForTransportProtocol 

func PossibleValuesForTransportProtocol() []string

func PossibleValuesForVirtualMachineCreationSource 

func PossibleValuesForVirtualMachineCreationSource() []string

func ValidateLabID 

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

ValidateLabID checks that 'input' can be parsed as a Lab ID

func ValidateVirtualMachineID 

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

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

Types

type AddDataDiskOperationResponse 

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

type ApplicableSchedule 

type ApplicableSchedule struct {
	Id         *string                      `json:"id,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties ApplicableScheduleProperties `json:"properties"`
	Tags       *map[string]string           `json:"tags,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type ApplicableScheduleProperties 

type ApplicableScheduleProperties struct {
	LabVMsShutdown *Schedule `json:"labVmsShutdown,omitempty"`
	LabVMsStartup  *Schedule `json:"labVmsStartup,omitempty"`
}

type ApplyArtifactsOperationResponse 

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

type ApplyArtifactsRequest 

type ApplyArtifactsRequest struct {
	Artifacts *[]ArtifactInstallProperties `json:"artifacts,omitempty"`
}

type ArtifactDeploymentStatusProperties 

type ArtifactDeploymentStatusProperties struct {
	ArtifactsApplied *int64  `json:"artifactsApplied,omitempty"`
	DeploymentStatus *string `json:"deploymentStatus,omitempty"`
	TotalArtifacts   *int64  `json:"totalArtifacts,omitempty"`
}

type ArtifactInstallProperties 

type ArtifactInstallProperties struct {
	ArtifactId               *string                        `json:"artifactId,omitempty"`
	ArtifactTitle            *string                        `json:"artifactTitle,omitempty"`
	DeploymentStatusMessage  *string                        `json:"deploymentStatusMessage,omitempty"`
	InstallTime              *string                        `json:"installTime,omitempty"`
	Parameters               *[]ArtifactParameterProperties `json:"parameters,omitempty"`
	Status                   *string                        `json:"status,omitempty"`
	VMExtensionStatusMessage *string                        `json:"vmExtensionStatusMessage,omitempty"`
}

func (*ArtifactInstallProperties) GetInstallTimeAsTime 

func (o *ArtifactInstallProperties) GetInstallTimeAsTime() (*time.Time, error)

func (*ArtifactInstallProperties) SetInstallTimeAsTime 

func (o *ArtifactInstallProperties) SetInstallTimeAsTime(input time.Time)

type ArtifactParameterProperties 

type ArtifactParameterProperties struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type AttachNewDataDiskOptions 

type AttachNewDataDiskOptions struct {
	DiskName    *string      `json:"diskName,omitempty"`
	DiskSizeGiB *int64       `json:"diskSizeGiB,omitempty"`
	DiskType    *StorageType `json:"diskType,omitempty"`
}

type ClaimOperationResponse 

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

type ComputeDataDisk 

type ComputeDataDisk struct {
	DiskSizeGiB   *int64  `json:"diskSizeGiB,omitempty"`
	DiskUri       *string `json:"diskUri,omitempty"`
	ManagedDiskId *string `json:"managedDiskId,omitempty"`
	Name          *string `json:"name,omitempty"`
}

type ComputeVMInstanceViewStatus 

type ComputeVMInstanceViewStatus struct {
	Code          *string `json:"code,omitempty"`
	DisplayStatus *string `json:"displayStatus,omitempty"`
	Message       *string `json:"message,omitempty"`
}

type ComputeVMProperties 

type ComputeVMProperties struct {
	DataDiskIds        *[]string                      `json:"dataDiskIds,omitempty"`
	DataDisks          *[]ComputeDataDisk             `json:"dataDisks,omitempty"`
	NetworkInterfaceId *string                        `json:"networkInterfaceId,omitempty"`
	OsDiskId           *string                        `json:"osDiskId,omitempty"`
	OsType             *string                        `json:"osType,omitempty"`
	Statuses           *[]ComputeVMInstanceViewStatus `json:"statuses,omitempty"`
	VMSize             *string                        `json:"vmSize,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DataDiskProperties 

type DataDiskProperties struct {
	AttachNewDataDiskOptions *AttachNewDataDiskOptions `json:"attachNewDataDiskOptions,omitempty"`
	ExistingLabDiskId        *string                   `json:"existingLabDiskId,omitempty"`
	HostCaching              *HostCachingOptions       `json:"hostCaching,omitempty"`
}

type DayDetails 

type DayDetails struct {
	Time *string `json:"time,omitempty"`
}

type DeleteOperationResponse 

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

type DetachDataDiskOperationResponse 

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

type DetachDataDiskProperties 

type DetachDataDiskProperties struct {
	ExistingLabDiskId *string `json:"existingLabDiskId,omitempty"`
}

type EnableStatus 

type EnableStatus string
const (
	EnableStatusDisabled EnableStatus = "Disabled"
	EnableStatusEnabled  EnableStatus = "Enabled"
)

func (*EnableStatus) UnmarshalJSON added in v0.20230815.1165905 

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

type GalleryImageReference 

type GalleryImageReference struct {
	Offer     *string `json:"offer,omitempty"`
	OsType    *string `json:"osType,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
	Sku       *string `json:"sku,omitempty"`
	Version   *string `json:"version,omitempty"`
}

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders added in v0.20230815.1165905 

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

func (GetOperationOptions) ToOData added in v0.20230815.1165905 

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

func (GetOperationOptions) ToQuery added in v0.20230815.1165905 

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

type GetOperationResponse 

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

type GetRdpFileContentsOperationResponse 

type GetRdpFileContentsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RdpConnection
}

type HostCachingOptions 

type HostCachingOptions string
const (
	HostCachingOptionsNone      HostCachingOptions = "None"
	HostCachingOptionsReadOnly  HostCachingOptions = "ReadOnly"
	HostCachingOptionsReadWrite HostCachingOptions = "ReadWrite"
)

func (*HostCachingOptions) UnmarshalJSON added in v0.20230815.1165905 

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

type HourDetails 

type HourDetails struct {
	Minute *int64 `json:"minute,omitempty"`
}

type InboundNatRule 

type InboundNatRule struct {
	BackendPort       *int64             `json:"backendPort,omitempty"`
	FrontendPort      *int64             `json:"frontendPort,omitempty"`
	TransportProtocol *TransportProtocol `json:"transportProtocol,omitempty"`
}

type LabId 

type LabId struct {
	SubscriptionId    string
	ResourceGroupName string
	LabName           string
}

LabId is a struct representing the Resource ID for a Lab

func NewLabID 

func NewLabID(subscriptionId string, resourceGroupName string, labName string) LabId

NewLabID returns a new LabId struct

func ParseLabID 

func ParseLabID(input string) (*LabId, error)

ParseLabID parses 'input' into a LabId

func ParseLabIDInsensitively 

func ParseLabIDInsensitively(input string) (*LabId, error)

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

func (*LabId) FromParseResult added in v0.20231127.1171502 

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

func (LabId) ID 

func (id LabId) ID() string

ID returns the formatted Lab ID

func (LabId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Lab ID

func (LabId) String 

func (id LabId) String() string

String returns a human-readable description of this Lab ID

type LabVirtualMachine 

type LabVirtualMachine struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties LabVirtualMachineProperties `json:"properties"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type LabVirtualMachineOperationPredicate 

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

func (LabVirtualMachineOperationPredicate) Matches 

func (p LabVirtualMachineOperationPredicate) Matches(input LabVirtualMachine) bool

type LabVirtualMachineProperties 

type LabVirtualMachineProperties struct {
	AllowClaim                   *bool                               `json:"allowClaim,omitempty"`
	ApplicableSchedule           *ApplicableSchedule                 `json:"applicableSchedule,omitempty"`
	ArtifactDeploymentStatus     *ArtifactDeploymentStatusProperties `json:"artifactDeploymentStatus,omitempty"`
	Artifacts                    *[]ArtifactInstallProperties        `json:"artifacts,omitempty"`
	ComputeId                    *string                             `json:"computeId,omitempty"`
	ComputeVM                    *ComputeVMProperties                `json:"computeVm,omitempty"`
	CreatedByUser                *string                             `json:"createdByUser,omitempty"`
	CreatedByUserId              *string                             `json:"createdByUserId,omitempty"`
	CreatedDate                  *string                             `json:"createdDate,omitempty"`
	CustomImageId                *string                             `json:"customImageId,omitempty"`
	DataDiskParameters           *[]DataDiskProperties               `json:"dataDiskParameters,omitempty"`
	DisallowPublicIPAddress      *bool                               `json:"disallowPublicIpAddress,omitempty"`
	EnvironmentId                *string                             `json:"environmentId,omitempty"`
	ExpirationDate               *string                             `json:"expirationDate,omitempty"`
	Fqdn                         *string                             `json:"fqdn,omitempty"`
	GalleryImageReference        *GalleryImageReference              `json:"galleryImageReference,omitempty"`
	IsAuthenticationWithSshKey   *bool                               `json:"isAuthenticationWithSshKey,omitempty"`
	LabSubnetName                *string                             `json:"labSubnetName,omitempty"`
	LabVirtualNetworkId          *string                             `json:"labVirtualNetworkId,omitempty"`
	LastKnownPowerState          *string                             `json:"lastKnownPowerState,omitempty"`
	NetworkInterface             *NetworkInterfaceProperties         `json:"networkInterface,omitempty"`
	Notes                        *string                             `json:"notes,omitempty"`
	OsType                       *string                             `json:"osType,omitempty"`
	OwnerObjectId                *string                             `json:"ownerObjectId,omitempty"`
	OwnerUserPrincipalName       *string                             `json:"ownerUserPrincipalName,omitempty"`
	Password                     *string                             `json:"password,omitempty"`
	PlanId                       *string                             `json:"planId,omitempty"`
	ProvisioningState            *string                             `json:"provisioningState,omitempty"`
	ScheduleParameters           *[]ScheduleCreationParameter        `json:"scheduleParameters,omitempty"`
	Size                         *string                             `json:"size,omitempty"`
	SshKey                       *string                             `json:"sshKey,omitempty"`
	StorageType                  *string                             `json:"storageType,omitempty"`
	UniqueIdentifier             *string                             `json:"uniqueIdentifier,omitempty"`
	UserName                     *string                             `json:"userName,omitempty"`
	VirtualMachineCreationSource *VirtualMachineCreationSource       `json:"virtualMachineCreationSource,omitempty"`
}

func (*LabVirtualMachineProperties) GetCreatedDateAsTime 

func (o *LabVirtualMachineProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*LabVirtualMachineProperties) GetExpirationDateAsTime 

func (o *LabVirtualMachineProperties) GetExpirationDateAsTime() (*time.Time, error)

func (*LabVirtualMachineProperties) SetCreatedDateAsTime 

func (o *LabVirtualMachineProperties) SetCreatedDateAsTime(input time.Time)

func (*LabVirtualMachineProperties) SetExpirationDateAsTime 

func (o *LabVirtualMachineProperties) SetExpirationDateAsTime(input time.Time)

type ListApplicableSchedulesOperationResponse 

type ListApplicableSchedulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicableSchedule
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []LabVirtualMachine
}

type ListOperationOptions 

type ListOperationOptions struct {
	Expand  *string
	Filter  *string
	Orderby *string
	Top     *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230815.1165905 

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

func (ListOperationOptions) ToOData added in v0.20230815.1165905 

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

func (ListOperationOptions) ToQuery added in v0.20230815.1165905 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]LabVirtualMachine
}

type NetworkInterfaceProperties 

type NetworkInterfaceProperties struct {
	DnsName                            *string                             `json:"dnsName,omitempty"`
	PrivateIPAddress                   *string                             `json:"privateIpAddress,omitempty"`
	PublicIPAddress                    *string                             `json:"publicIpAddress,omitempty"`
	PublicIPAddressId                  *string                             `json:"publicIpAddressId,omitempty"`
	RdpAuthority                       *string                             `json:"rdpAuthority,omitempty"`
	SharedPublicIPAddressConfiguration *SharedPublicIPAddressConfiguration `json:"sharedPublicIpAddressConfiguration,omitempty"`
	SshAuthority                       *string                             `json:"sshAuthority,omitempty"`
	SubnetId                           *string                             `json:"subnetId,omitempty"`
	VirtualNetworkId                   *string                             `json:"virtualNetworkId,omitempty"`
}

type NotificationSettings 

type NotificationSettings struct {
	EmailRecipient     *string       `json:"emailRecipient,omitempty"`
	NotificationLocale *string       `json:"notificationLocale,omitempty"`
	Status             *EnableStatus `json:"status,omitempty"`
	TimeInMinutes      *int64        `json:"timeInMinutes,omitempty"`
	WebhookUrl         *string       `json:"webhookUrl,omitempty"`
}

type RdpConnection 

type RdpConnection struct {
	Contents *string `json:"contents,omitempty"`
}

type RedeployOperationResponse 

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

type ResizeLabVirtualMachineProperties 

type ResizeLabVirtualMachineProperties struct {
	Size *string `json:"size,omitempty"`
}

type ResizeOperationResponse 

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

type RestartOperationResponse 

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

type Schedule 

type Schedule struct {
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties ScheduleProperties `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type ScheduleCreationParameter 

type ScheduleCreationParameter struct {
	Location   *string                              `json:"location,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *ScheduleCreationParameterProperties `json:"properties,omitempty"`
	Tags       *map[string]string                   `json:"tags,omitempty"`
}

type ScheduleCreationParameterProperties 

type ScheduleCreationParameterProperties struct {
	DailyRecurrence      *DayDetails           `json:"dailyRecurrence,omitempty"`
	HourlyRecurrence     *HourDetails          `json:"hourlyRecurrence,omitempty"`
	NotificationSettings *NotificationSettings `json:"notificationSettings,omitempty"`
	Status               *EnableStatus         `json:"status,omitempty"`
	TargetResourceId     *string               `json:"targetResourceId,omitempty"`
	TaskType             *string               `json:"taskType,omitempty"`
	TimeZoneId           *string               `json:"timeZoneId,omitempty"`
	WeeklyRecurrence     *WeekDetails          `json:"weeklyRecurrence,omitempty"`
}

type ScheduleProperties 

type ScheduleProperties struct {
	CreatedDate          *string               `json:"createdDate,omitempty"`
	DailyRecurrence      *DayDetails           `json:"dailyRecurrence,omitempty"`
	HourlyRecurrence     *HourDetails          `json:"hourlyRecurrence,omitempty"`
	NotificationSettings *NotificationSettings `json:"notificationSettings,omitempty"`
	ProvisioningState    *string               `json:"provisioningState,omitempty"`
	Status               *EnableStatus         `json:"status,omitempty"`
	TargetResourceId     *string               `json:"targetResourceId,omitempty"`
	TaskType             *string               `json:"taskType,omitempty"`
	TimeZoneId           *string               `json:"timeZoneId,omitempty"`
	UniqueIdentifier     *string               `json:"uniqueIdentifier,omitempty"`
	WeeklyRecurrence     *WeekDetails          `json:"weeklyRecurrence,omitempty"`
}

func (*ScheduleProperties) GetCreatedDateAsTime 

func (o *ScheduleProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*ScheduleProperties) SetCreatedDateAsTime 

func (o *ScheduleProperties) SetCreatedDateAsTime(input time.Time)

type SharedPublicIPAddressConfiguration 

type SharedPublicIPAddressConfiguration struct {
	InboundNatRules *[]InboundNatRule `json:"inboundNatRules,omitempty"`
}

type StartOperationResponse 

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

type StopOperationResponse 

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

type StorageType 

type StorageType string
const (
	StorageTypePremium     StorageType = "Premium"
	StorageTypeStandard    StorageType = "Standard"
	StorageTypeStandardSSD StorageType = "StandardSSD"
)

func (*StorageType) UnmarshalJSON added in v0.20230815.1165905 

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

type TransferDisksOperationResponse 

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

type TransportProtocol 

type TransportProtocol string
const (
	TransportProtocolTcp TransportProtocol = "Tcp"
	TransportProtocolUdp TransportProtocol = "Udp"
)

func (*TransportProtocol) UnmarshalJSON added in v0.20230815.1165905 

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

type UnClaimOperationResponse 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LabVirtualMachine
}

type UpdateResource 

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

type VirtualMachineCreationSource 

type VirtualMachineCreationSource string
const (
	VirtualMachineCreationSourceFromCustomImage        VirtualMachineCreationSource = "FromCustomImage"
	VirtualMachineCreationSourceFromGalleryImage       VirtualMachineCreationSource = "FromGalleryImage"
	VirtualMachineCreationSourceFromSharedGalleryImage VirtualMachineCreationSource = "FromSharedGalleryImage"
)

func (*VirtualMachineCreationSource) UnmarshalJSON added in v0.20230815.1165905 

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

type VirtualMachineId 

type VirtualMachineId struct {
	SubscriptionId     string
	ResourceGroupName  string
	LabName            string
	VirtualMachineName string
}

VirtualMachineId is a struct representing the Resource ID for a Virtual Machine

func NewVirtualMachineID 

func NewVirtualMachineID(subscriptionId string, resourceGroupName string, labName string, virtualMachineName string) VirtualMachineId

NewVirtualMachineID returns a new VirtualMachineId struct

func ParseVirtualMachineID 

func ParseVirtualMachineID(input string) (*VirtualMachineId, error)

ParseVirtualMachineID parses 'input' into a VirtualMachineId

func ParseVirtualMachineIDInsensitively 

func ParseVirtualMachineIDInsensitively(input string) (*VirtualMachineId, error)

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

func (*VirtualMachineId) FromParseResult added in v0.20231127.1171502 

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

func (VirtualMachineId) ID 

func (id VirtualMachineId) ID() string

ID returns the formatted Virtual Machine ID

func (VirtualMachineId) Segments 

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

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

func (VirtualMachineId) String 

func (id VirtualMachineId) String() string

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

type VirtualMachinesClient 

type VirtualMachinesClient struct {
	Client *resourcemanager.Client
}

func NewVirtualMachinesClientWithBaseURI 

func NewVirtualMachinesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualMachinesClient, error)

func (VirtualMachinesClient) AddDataDisk 

func (c VirtualMachinesClient) AddDataDisk(ctx context.Context, id VirtualMachineId, input DataDiskProperties) (result AddDataDiskOperationResponse, err error)

AddDataDisk ...

func (VirtualMachinesClient) AddDataDiskThenPoll 

func (c VirtualMachinesClient) AddDataDiskThenPoll(ctx context.Context, id VirtualMachineId, input DataDiskProperties) error

AddDataDiskThenPoll performs AddDataDisk then polls until it's completed

func (VirtualMachinesClient) ApplyArtifacts 

func (c VirtualMachinesClient) ApplyArtifacts(ctx context.Context, id VirtualMachineId, input ApplyArtifactsRequest) (result ApplyArtifactsOperationResponse, err error)

ApplyArtifacts ...

func (VirtualMachinesClient) ApplyArtifactsThenPoll 

func (c VirtualMachinesClient) ApplyArtifactsThenPoll(ctx context.Context, id VirtualMachineId, input ApplyArtifactsRequest) error

ApplyArtifactsThenPoll performs ApplyArtifacts then polls until it's completed

func (VirtualMachinesClient) Claim 

func (c VirtualMachinesClient) Claim(ctx context.Context, id VirtualMachineId) (result ClaimOperationResponse, err error)

Claim ...

func (VirtualMachinesClient) ClaimThenPoll 

func (c VirtualMachinesClient) ClaimThenPoll(ctx context.Context, id VirtualMachineId) error

ClaimThenPoll performs Claim then polls until it's completed

func (VirtualMachinesClient) CreateOrUpdate 

func (c VirtualMachinesClient) CreateOrUpdate(ctx context.Context, id VirtualMachineId, input LabVirtualMachine) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VirtualMachinesClient) CreateOrUpdateThenPoll 

func (c VirtualMachinesClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualMachineId, input LabVirtualMachine) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualMachinesClient) Delete 

func (c VirtualMachinesClient) Delete(ctx context.Context, id VirtualMachineId) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualMachinesClient) DeleteThenPoll 

func (c VirtualMachinesClient) DeleteThenPoll(ctx context.Context, id VirtualMachineId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualMachinesClient) DetachDataDisk 

func (c VirtualMachinesClient) DetachDataDisk(ctx context.Context, id VirtualMachineId, input DetachDataDiskProperties) (result DetachDataDiskOperationResponse, err error)

DetachDataDisk ...

func (VirtualMachinesClient) DetachDataDiskThenPoll 

func (c VirtualMachinesClient) DetachDataDiskThenPoll(ctx context.Context, id VirtualMachineId, input DetachDataDiskProperties) error

DetachDataDiskThenPoll performs DetachDataDisk then polls until it's completed

func (VirtualMachinesClient) Get 

func (c VirtualMachinesClient) Get(ctx context.Context, id VirtualMachineId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (VirtualMachinesClient) GetRdpFileContents 

func (c VirtualMachinesClient) GetRdpFileContents(ctx context.Context, id VirtualMachineId) (result GetRdpFileContentsOperationResponse, err error)

GetRdpFileContents ...

func (VirtualMachinesClient) List 

func (c VirtualMachinesClient) List(ctx context.Context, id LabId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (VirtualMachinesClient) ListApplicableSchedules 

func (c VirtualMachinesClient) ListApplicableSchedules(ctx context.Context, id VirtualMachineId) (result ListApplicableSchedulesOperationResponse, err error)

ListApplicableSchedules ...

func (VirtualMachinesClient) ListComplete 

func (c VirtualMachinesClient) ListComplete(ctx context.Context, id LabId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (VirtualMachinesClient) ListCompleteMatchingPredicate 

func (c VirtualMachinesClient) ListCompleteMatchingPredicate(ctx context.Context, id LabId, options ListOperationOptions, predicate LabVirtualMachineOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualMachinesClient) Redeploy 

func (c VirtualMachinesClient) Redeploy(ctx context.Context, id VirtualMachineId) (result RedeployOperationResponse, err error)

Redeploy ...

func (VirtualMachinesClient) RedeployThenPoll 

func (c VirtualMachinesClient) RedeployThenPoll(ctx context.Context, id VirtualMachineId) error

RedeployThenPoll performs Redeploy then polls until it's completed

func (VirtualMachinesClient) Resize 

func (c VirtualMachinesClient) Resize(ctx context.Context, id VirtualMachineId, input ResizeLabVirtualMachineProperties) (result ResizeOperationResponse, err error)

Resize ...

func (VirtualMachinesClient) ResizeThenPoll 

func (c VirtualMachinesClient) ResizeThenPoll(ctx context.Context, id VirtualMachineId, input ResizeLabVirtualMachineProperties) error

ResizeThenPoll performs Resize then polls until it's completed

func (VirtualMachinesClient) Restart 

func (c VirtualMachinesClient) Restart(ctx context.Context, id VirtualMachineId) (result RestartOperationResponse, err error)

Restart ...

func (VirtualMachinesClient) RestartThenPoll 

func (c VirtualMachinesClient) RestartThenPoll(ctx context.Context, id VirtualMachineId) error

RestartThenPoll performs Restart then polls until it's completed

func (VirtualMachinesClient) Start 

func (c VirtualMachinesClient) Start(ctx context.Context, id VirtualMachineId) (result StartOperationResponse, err error)

Start ...

func (VirtualMachinesClient) StartThenPoll 

func (c VirtualMachinesClient) StartThenPoll(ctx context.Context, id VirtualMachineId) error

StartThenPoll performs Start then polls until it's completed

func (VirtualMachinesClient) Stop 

func (c VirtualMachinesClient) Stop(ctx context.Context, id VirtualMachineId) (result StopOperationResponse, err error)

Stop ...

func (VirtualMachinesClient) StopThenPoll 

func (c VirtualMachinesClient) StopThenPoll(ctx context.Context, id VirtualMachineId) error

StopThenPoll performs Stop then polls until it's completed

func (VirtualMachinesClient) TransferDisks 

func (c VirtualMachinesClient) TransferDisks(ctx context.Context, id VirtualMachineId) (result TransferDisksOperationResponse, err error)

TransferDisks ...

func (VirtualMachinesClient) TransferDisksThenPoll 

func (c VirtualMachinesClient) TransferDisksThenPoll(ctx context.Context, id VirtualMachineId) error

TransferDisksThenPoll performs TransferDisks then polls until it's completed

func (VirtualMachinesClient) UnClaim 

func (c VirtualMachinesClient) UnClaim(ctx context.Context, id VirtualMachineId) (result UnClaimOperationResponse, err error)

UnClaim ...

func (VirtualMachinesClient) UnClaimThenPoll 

func (c VirtualMachinesClient) UnClaimThenPoll(ctx context.Context, id VirtualMachineId) error

UnClaimThenPoll performs UnClaim then polls until it's completed

func (VirtualMachinesClient) Update 

func (c VirtualMachinesClient) Update(ctx context.Context, id VirtualMachineId, input UpdateResource) (result UpdateOperationResponse, err error)

Update ...

type WeekDetails 

type WeekDetails struct {
	Time     *string   `json:"time,omitempty"`
	Weekdays *[]string `json:"weekdays,omitempty"`
}

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.