dedicatedhost

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2021-07-01/dedicatedhost Documentation

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

Client Initialization

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

Example Usage: DedicatedHostClient.ListByHostGroup

ctx := context.TODO()
id := commonids.NewDedicatedHostGroupID("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
}

Documentation

Index

• func PossibleValuesForDedicatedHostLicenseTypes() []string
• func PossibleValuesForStatusLevelTypes() []string
• type DedicatedHost
• type DedicatedHostAllocatableVM
• type DedicatedHostAvailableCapacity
• type DedicatedHostClient
  • func NewDedicatedHostClientWithBaseURI(sdkApi sdkEnv.Api) (*DedicatedHostClient, error)
  • func (c DedicatedHostClient) ListByHostGroup(ctx context.Context, id commonids.DedicatedHostGroupId) (result ListByHostGroupOperationResponse, err error)
  • func (c DedicatedHostClient) ListByHostGroupComplete(ctx context.Context, id commonids.DedicatedHostGroupId) (ListByHostGroupCompleteResult, error)
  • func (c DedicatedHostClient) ListByHostGroupCompleteMatchingPredicate(ctx context.Context, id commonids.DedicatedHostGroupId, ...) (result ListByHostGroupCompleteResult, err error)
• type DedicatedHostInstanceView
• type DedicatedHostLicenseTypes
  • func (s *DedicatedHostLicenseTypes) UnmarshalJSON(bytes []byte) error
• type DedicatedHostOperationPredicate
  • func (p DedicatedHostOperationPredicate) Matches(input DedicatedHost) bool
• type DedicatedHostProperties
  • func (o *DedicatedHostProperties) GetProvisioningTimeAsTime() (*time.Time, error)
  • func (o *DedicatedHostProperties) SetProvisioningTimeAsTime(input time.Time)
• type InstanceViewStatus
  • func (o *InstanceViewStatus) GetTimeAsTime() (*time.Time, error)
  • func (o *InstanceViewStatus) SetTimeAsTime(input time.Time)
• type ListByHostGroupCompleteResult
• type ListByHostGroupOperationResponse
• type Sku
• type StatusLevelTypes
  • func (s *StatusLevelTypes) UnmarshalJSON(bytes []byte) error
• type SubResourceReadOnly

Functions

func PossibleValuesForDedicatedHostLicenseTypes

func PossibleValuesForDedicatedHostLicenseTypes() []string

func PossibleValuesForStatusLevelTypes

func PossibleValuesForStatusLevelTypes() []string

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 commonids.DedicatedHostGroupId) (result ListByHostGroupOperationResponse, err error)

ListByHostGroup ...

func (DedicatedHostClient) ListByHostGroupComplete

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

ListByHostGroupComplete retrieves all the results into a single object

func (DedicatedHostClient) ListByHostGroupCompleteMatchingPredicate

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

ListByHostGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

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"`
	VirtualMachines      *[]SubResourceReadOnly     `json:"virtualMachines,omitempty"`
}

func (*DedicatedHostProperties) GetProvisioningTimeAsTime

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

func (*DedicatedHostProperties) SetProvisioningTimeAsTime

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

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 {
	LatestHttpResponse *http.Response
	Items              []DedicatedHost
}

type ListByHostGroupOperationResponse

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

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

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

type SubResourceReadOnly

type SubResourceReadOnly struct {
	Id *string `json:"id,omitempty"`
}