dedicatedhosts

package
v0.20230803.1110121 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-03-01/dedicatedhosts Documentation

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

Client Initialization

client := dedicatedhosts.NewDedicatedHostsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DedicatedHostsClient.CreateOrUpdate

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

payload := dedicatedhosts.DedicatedHost{
	// ...
}


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

Example Usage: DedicatedHostsClient.Delete

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

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

Example Usage: DedicatedHostsClient.Get

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

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

Example Usage: DedicatedHostsClient.Update

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

payload := dedicatedhosts.DedicatedHostUpdate{
	// ...
}


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 PossibleValuesForDedicatedHostLicenseTypes 

func PossibleValuesForDedicatedHostLicenseTypes() []string

func PossibleValuesForInstanceViewTypes 

func PossibleValuesForInstanceViewTypes() []string

func PossibleValuesForStatusLevelTypes 

func PossibleValuesForStatusLevelTypes() []string

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 CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

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

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 DedicatedHostUpdate 

type DedicatedHostUpdate struct {
	Properties *DedicatedHostProperties `json:"properties,omitempty"`
	Sku        *Sku                     `json:"sku,omitempty"`
	Tags       *map[string]string       `json:"tags,omitempty"`
}

type DedicatedHostsClient 

type DedicatedHostsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDedicatedHostsClientWithBaseURI 

func NewDedicatedHostsClientWithBaseURI(endpoint string) DedicatedHostsClient

func (DedicatedHostsClient) CreateOrUpdate 

func (c DedicatedHostsClient) CreateOrUpdate(ctx context.Context, id HostId, input DedicatedHost) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DedicatedHostsClient) CreateOrUpdateThenPoll 

func (c DedicatedHostsClient) CreateOrUpdateThenPoll(ctx context.Context, id HostId, input DedicatedHost) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DedicatedHostsClient) Delete 

func (c DedicatedHostsClient) Delete(ctx context.Context, id HostId) (result DeleteOperationResponse, err error)

Delete ...

func (DedicatedHostsClient) DeleteThenPoll 

func (c DedicatedHostsClient) DeleteThenPoll(ctx context.Context, id HostId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DedicatedHostsClient) Get 

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

Get ...

func (DedicatedHostsClient) Update 

func (c DedicatedHostsClient) Update(ctx context.Context, id HostId, input DedicatedHostUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DedicatedHostsClient) UpdateThenPoll 

func (c DedicatedHostsClient) UpdateThenPoll(ctx context.Context, id HostId, input DedicatedHostUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *InstanceViewTypes
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DedicatedHost
}

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) 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 InstanceViewTypes 

type InstanceViewTypes string
const (
	InstanceViewTypesInstanceView InstanceViewTypes = "instanceView"
	InstanceViewTypesUserData     InstanceViewTypes = "userData"
)

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

type SubResourceReadOnly 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

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.