README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/compute/2021-07-01/dedicatedhostgroups
Documentation
The dedicatedhostgroups
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/dedicatedhostgroups"
Client Initialization
client := dedicatedhostgroups.NewDedicatedHostGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: DedicatedHostGroupsClient.CreateOrUpdate
ctx := context.TODO()
id := commonids.NewDedicatedHostGroupID("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 := commonids.NewDedicatedHostGroupID("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 := commonids.NewDedicatedHostGroupID("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 := commonids.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 := commonids.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 := commonids.NewDedicatedHostGroupID("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 ¶
- func PossibleValuesForInstanceViewTypes() []string
- func PossibleValuesForStatusLevelTypes() []string
- type CreateOrUpdateOperationResponse
- type DedicatedHostAllocatableVM
- type DedicatedHostAvailableCapacity
- type DedicatedHostGroup
- type DedicatedHostGroupInstanceView
- type DedicatedHostGroupOperationPredicate
- type DedicatedHostGroupProperties
- type DedicatedHostGroupUpdate
- type DedicatedHostGroupsClient
- func (c DedicatedHostGroupsClient) CreateOrUpdate(ctx context.Context, id commonids.DedicatedHostGroupId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c DedicatedHostGroupsClient) Delete(ctx context.Context, id commonids.DedicatedHostGroupId) (result DeleteOperationResponse, err error)
- func (c DedicatedHostGroupsClient) Get(ctx context.Context, id commonids.DedicatedHostGroupId, ...) (result GetOperationResponse, err error)
- func (c DedicatedHostGroupsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c DedicatedHostGroupsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c DedicatedHostGroupsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c DedicatedHostGroupsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
- func (c DedicatedHostGroupsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
- func (c DedicatedHostGroupsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
- func (c DedicatedHostGroupsClient) Update(ctx context.Context, id commonids.DedicatedHostGroupId, ...) (result UpdateOperationResponse, err error)
- type DedicatedHostInstanceViewWithName
- type DeleteOperationResponse
- type GetOperationOptions
- type GetOperationResponse
- type InstanceViewStatus
- type InstanceViewTypes
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionOperationResponse
- type StatusLevelTypes
- type SubResourceReadOnly
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForInstanceViewTypes ¶
func PossibleValuesForInstanceViewTypes() []string
func PossibleValuesForStatusLevelTypes ¶
func PossibleValuesForStatusLevelTypes() []string
Types ¶
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *DedicatedHostGroup }
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 { Hosts *[]SubResourceReadOnly `json:"hosts,omitempty"` InstanceView *DedicatedHostGroupInstanceView `json:"instanceView,omitempty"` PlatformFaultDomainCount int64 `json:"platformFaultDomainCount"` SupportAutomaticPlacement *bool `json:"supportAutomaticPlacement,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 commonids.DedicatedHostGroupId, input DedicatedHostGroup) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (DedicatedHostGroupsClient) Delete ¶
func (c DedicatedHostGroupsClient) Delete(ctx context.Context, id commonids.DedicatedHostGroupId) (result DeleteOperationResponse, err error)
Delete ...
func (DedicatedHostGroupsClient) Get ¶
func (c DedicatedHostGroupsClient) Get(ctx context.Context, id commonids.DedicatedHostGroupId, 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 commonids.DedicatedHostGroupId, 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 GetOperationOptions ¶
type GetOperationOptions struct {
Expand *InstanceViewTypes
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *DedicatedHostGroup }
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 ¶
func (s *InstanceViewTypes) UnmarshalJSON(bytes []byte) error
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct { LatestHttpResponse *http.Response Items []DedicatedHostGroup }
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]DedicatedHostGroup }
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct { LatestHttpResponse *http.Response 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 ¶
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 ¶
- client.go
- constants.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbyresourcegroup.go
- method_listbysubscription.go
- method_update.go
- model_dedicatedhostallocatablevm.go
- model_dedicatedhostavailablecapacity.go
- model_dedicatedhostgroup.go
- model_dedicatedhostgroupinstanceview.go
- model_dedicatedhostgroupproperties.go
- model_dedicatedhostgroupupdate.go
- model_dedicatedhostinstanceviewwithname.go
- model_instanceviewstatus.go
- model_subresourcereadonly.go
- predicates.go
- version.go