dedicatedhost

package
v0.20231214.1160726 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-01/dedicatedhost Documentation

The dedicatedhost SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2022-03-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/compute/2022-03-01/dedicatedhost"

Client Initialization

client := dedicatedhost.NewDedicatedHostClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DedicatedHostClient.ListByHostGroup

ctx := context.TODO()
id := dedicatedhost.NewHostGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hostGroupValue")

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

Example Usage: DedicatedHostClient.Restart

ctx := context.TODO()
id := dedicatedhost.NewHostID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hostGroupValue", "hostValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDedicatedHostLicenseTypes 

func PossibleValuesForDedicatedHostLicenseTypes() []string

func PossibleValuesForStatusLevelTypes 

func PossibleValuesForStatusLevelTypes() []string

func ValidateHostGroupID 

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

ValidateHostGroupID checks that 'input' can be parsed as a Host Group ID

func ValidateHostID 

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

ValidateHostID checks that 'input' can be parsed as a Host ID

Types

type DedicatedHost 

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

type DedicatedHostAllocatableVM 

type DedicatedHostAllocatableVM struct {
	Count  *float64 `json:"count,omitempty"`
	VMSize *string  `json:"vmSize,omitempty"`
}

type DedicatedHostAvailableCapacity 

type DedicatedHostAvailableCapacity struct {
	AllocatableVMs *[]DedicatedHostAllocatableVM `json:"allocatableVMs,omitempty"`
}

type DedicatedHostClient 

type DedicatedHostClient struct {
	Client *resourcemanager.Client
}

func NewDedicatedHostClientWithBaseURI 

func NewDedicatedHostClientWithBaseURI(sdkApi sdkEnv.Api) (*DedicatedHostClient, error)

func (DedicatedHostClient) ListByHostGroup 

func (c DedicatedHostClient) ListByHostGroup(ctx context.Context, id HostGroupId) (result ListByHostGroupOperationResponse, err error)

ListByHostGroup ...

func (DedicatedHostClient) ListByHostGroupComplete 

func (c DedicatedHostClient) ListByHostGroupComplete(ctx context.Context, id HostGroupId) (ListByHostGroupCompleteResult, error)

ListByHostGroupComplete retrieves all the results into a single object

func (DedicatedHostClient) ListByHostGroupCompleteMatchingPredicate 

func (c DedicatedHostClient) ListByHostGroupCompleteMatchingPredicate(ctx context.Context, id HostGroupId, predicate DedicatedHostOperationPredicate) (result ListByHostGroupCompleteResult, err error)

ListByHostGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DedicatedHostClient) Restart 

func (c DedicatedHostClient) Restart(ctx context.Context, id HostId) (result RestartOperationResponse, err error)

Restart ...

func (DedicatedHostClient) RestartThenPoll 

func (c DedicatedHostClient) RestartThenPoll(ctx context.Context, id HostId) error

RestartThenPoll performs Restart then polls until it's completed

type DedicatedHostInstanceView 

type DedicatedHostInstanceView struct {
	AssetId           *string                         `json:"assetId,omitempty"`
	AvailableCapacity *DedicatedHostAvailableCapacity `json:"availableCapacity,omitempty"`
	Statuses          *[]InstanceViewStatus           `json:"statuses,omitempty"`
}

type DedicatedHostLicenseTypes 

type DedicatedHostLicenseTypes string
const (
	DedicatedHostLicenseTypesNone                   DedicatedHostLicenseTypes = "None"
	DedicatedHostLicenseTypesWindowsServerHybrid    DedicatedHostLicenseTypes = "Windows_Server_Hybrid"
	DedicatedHostLicenseTypesWindowsServerPerpetual DedicatedHostLicenseTypes = "Windows_Server_Perpetual"
)

func (*DedicatedHostLicenseTypes) UnmarshalJSON added in v0.20230808.1103829 

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

type DedicatedHostOperationPredicate 

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

func (DedicatedHostOperationPredicate) Matches 

func (p DedicatedHostOperationPredicate) Matches(input DedicatedHost) bool

type DedicatedHostProperties 

type DedicatedHostProperties struct {
	AutoReplaceOnFailure *bool                      `json:"autoReplaceOnFailure,omitempty"`
	HostId               *string                    `json:"hostId,omitempty"`
	InstanceView         *DedicatedHostInstanceView `json:"instanceView,omitempty"`
	LicenseType          *DedicatedHostLicenseTypes `json:"licenseType,omitempty"`
	PlatformFaultDomain  *int64                     `json:"platformFaultDomain,omitempty"`
	ProvisioningState    *string                    `json:"provisioningState,omitempty"`
	ProvisioningTime     *string                    `json:"provisioningTime,omitempty"`
	TimeCreated          *string                    `json:"timeCreated,omitempty"`
	VirtualMachines      *[]SubResourceReadOnly     `json:"virtualMachines,omitempty"`
}

func (*DedicatedHostProperties) GetProvisioningTimeAsTime 

func (o *DedicatedHostProperties) GetProvisioningTimeAsTime() (*time.Time, error)

func (*DedicatedHostProperties) GetTimeCreatedAsTime 

func (o *DedicatedHostProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*DedicatedHostProperties) SetProvisioningTimeAsTime 

func (o *DedicatedHostProperties) SetProvisioningTimeAsTime(input time.Time)

func (*DedicatedHostProperties) SetTimeCreatedAsTime 

func (o *DedicatedHostProperties) SetTimeCreatedAsTime(input time.Time)

type HostGroupId 

type HostGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	HostGroupName     string
}

HostGroupId is a struct representing the Resource ID for a Host Group

func NewHostGroupID 

func NewHostGroupID(subscriptionId string, resourceGroupName string, hostGroupName string) HostGroupId

NewHostGroupID returns a new HostGroupId struct

func ParseHostGroupID 

func ParseHostGroupID(input string) (*HostGroupId, error)

ParseHostGroupID parses 'input' into a HostGroupId

func ParseHostGroupIDInsensitively 

func ParseHostGroupIDInsensitively(input string) (*HostGroupId, error)

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

func (*HostGroupId) FromParseResult added in v0.20231127.1171502 

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

func (HostGroupId) ID 

func (id HostGroupId) ID() string

ID returns the formatted Host Group ID

func (HostGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Host Group ID

func (HostGroupId) String 

func (id HostGroupId) String() string

String returns a human-readable description of this Host Group ID

type HostId 

type HostId struct {
	SubscriptionId    string
	ResourceGroupName string
	HostGroupName     string
	HostName          string
}

HostId is a struct representing the Resource ID for a Host

func NewHostID 

func NewHostID(subscriptionId string, resourceGroupName string, hostGroupName string, hostName string) HostId

NewHostID returns a new HostId struct

func ParseHostID 

func ParseHostID(input string) (*HostId, error)

ParseHostID parses 'input' into a HostId

func ParseHostIDInsensitively 

func ParseHostIDInsensitively(input string) (*HostId, error)

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

func (*HostId) FromParseResult added in v0.20231127.1171502 

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

func (HostId) ID 

func (id HostId) ID() string

ID returns the formatted Host ID

func (HostId) Segments 

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

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

func (HostId) String 

func (id HostId) String() string

String returns a human-readable description of this Host ID

type InstanceViewStatus 

type InstanceViewStatus struct {
	Code          *string           `json:"code,omitempty"`
	DisplayStatus *string           `json:"displayStatus,omitempty"`
	Level         *StatusLevelTypes `json:"level,omitempty"`
	Message       *string           `json:"message,omitempty"`
	Time          *string           `json:"time,omitempty"`
}

func (*InstanceViewStatus) GetTimeAsTime 

func (o *InstanceViewStatus) GetTimeAsTime() (*time.Time, error)

func (*InstanceViewStatus) SetTimeAsTime 

func (o *InstanceViewStatus) SetTimeAsTime(input time.Time)

type ListByHostGroupCompleteResult 

type ListByHostGroupCompleteResult struct {
	Items []DedicatedHost
}

type ListByHostGroupOperationResponse 

type ListByHostGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DedicatedHost
}

type RestartOperationResponse 

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

type Sku 

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Name     *string `json:"name,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type StatusLevelTypes 

type StatusLevelTypes string
const (
	StatusLevelTypesError   StatusLevelTypes = "Error"
	StatusLevelTypesInfo    StatusLevelTypes = "Info"
	StatusLevelTypesWarning StatusLevelTypes = "Warning"
)

func (*StatusLevelTypes) UnmarshalJSON added in v0.20230808.1103829 

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

type SubResourceReadOnly 

type SubResourceReadOnly struct {
	Id *string `json:"id,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.