dedicatedhostgroups

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: 14 Imported by: 1

README

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

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

Client Initialization

client := dedicatedhostgroups.NewDedicatedHostGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DedicatedHostGroupsClient.CreateOrUpdate

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

payload := dedicatedhostgroups.DedicatedHostGroup{
	// ...
}


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

Example Usage: DedicatedHostGroupsClient.Delete

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

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: DedicatedHostGroupsClient.Get

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

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

Example Usage: DedicatedHostGroupsClient.ListByResourceGroup

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

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

Example Usage: DedicatedHostGroupsClient.ListBySubscription

ctx := context.TODO()
id := dedicatedhostgroups.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: DedicatedHostGroupsClient.Update

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

payload := dedicatedhostgroups.DedicatedHostGroupUpdate{
	// ...
}


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 PossibleValuesForInstanceViewTypes 

func PossibleValuesForInstanceViewTypes() []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

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DedicatedHostGroup
}

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 DedicatedHostGroup 

type DedicatedHostGroup struct {
	Id         *string                       `json:"id,omitempty"`
	Location   string                        `json:"location"`
	Name       *string                       `json:"name,omitempty"`
	Properties *DedicatedHostGroupProperties `json:"properties,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Type       *string                       `json:"type,omitempty"`
	Zones      *zones.Schema                 `json:"zones,omitempty"`
}

type DedicatedHostGroupInstanceView 

type DedicatedHostGroupInstanceView struct {
	Hosts *[]DedicatedHostInstanceViewWithName `json:"hosts,omitempty"`
}

type DedicatedHostGroupOperationPredicate 

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

func (DedicatedHostGroupOperationPredicate) Matches 

func (p DedicatedHostGroupOperationPredicate) Matches(input DedicatedHostGroup) bool

type DedicatedHostGroupProperties 

type DedicatedHostGroupProperties struct {
	AdditionalCapabilities    *DedicatedHostGroupPropertiesAdditionalCapabilities `json:"additionalCapabilities,omitempty"`
	Hosts                     *[]SubResourceReadOnly                              `json:"hosts,omitempty"`
	InstanceView              *DedicatedHostGroupInstanceView                     `json:"instanceView,omitempty"`
	PlatformFaultDomainCount  int64                                               `json:"platformFaultDomainCount"`
	SupportAutomaticPlacement *bool                                               `json:"supportAutomaticPlacement,omitempty"`
}

type DedicatedHostGroupPropertiesAdditionalCapabilities 

type DedicatedHostGroupPropertiesAdditionalCapabilities struct {
	UltraSSDEnabled *bool `json:"ultraSSDEnabled,omitempty"`
}

type DedicatedHostGroupUpdate 

type DedicatedHostGroupUpdate struct {
	Properties *DedicatedHostGroupProperties `json:"properties,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Zones      *zones.Schema                 `json:"zones,omitempty"`
}

type DedicatedHostGroupsClient 

type DedicatedHostGroupsClient struct {
	Client *resourcemanager.Client
}

func NewDedicatedHostGroupsClientWithBaseURI 

func NewDedicatedHostGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*DedicatedHostGroupsClient, error)

func (DedicatedHostGroupsClient) CreateOrUpdate 

func (c DedicatedHostGroupsClient) CreateOrUpdate(ctx context.Context, id HostGroupId, input DedicatedHostGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DedicatedHostGroupsClient) Delete 

func (c DedicatedHostGroupsClient) Delete(ctx context.Context, id HostGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (DedicatedHostGroupsClient) Get 

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

Get ...

func (DedicatedHostGroupsClient) ListByResourceGroup 

func (c DedicatedHostGroupsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (DedicatedHostGroupsClient) ListByResourceGroupComplete 

func (c DedicatedHostGroupsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (DedicatedHostGroupsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c DedicatedHostGroupsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate DedicatedHostGroupOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DedicatedHostGroupsClient) ListBySubscription 

func (c DedicatedHostGroupsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (DedicatedHostGroupsClient) ListBySubscriptionComplete 

func (c DedicatedHostGroupsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (DedicatedHostGroupsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c DedicatedHostGroupsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DedicatedHostGroupOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DedicatedHostGroupsClient) Update 

func (c DedicatedHostGroupsClient) Update(ctx context.Context, id HostGroupId, input DedicatedHostGroupUpdate) (result UpdateOperationResponse, err error)

Update ...

type DedicatedHostInstanceViewWithName 

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

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *InstanceViewTypes
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders added in v0.20230808.1103829 

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

func (GetOperationOptions) ToOData added in v0.20230808.1103829 

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

func (GetOperationOptions) ToQuery added in v0.20230808.1103829 

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

type GetOperationResponse 

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

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

func (*InstanceViewTypes) UnmarshalJSON added in v0.20230808.1103829 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []DedicatedHostGroup
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DedicatedHostGroup
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	Items []DedicatedHostGroup
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DedicatedHostGroup
}

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"`
}

type UpdateOperationResponse 

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

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.