proximityplacementgroups

package
v0.20240527.1094340 Latest Latest
Warning

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

 Go to latest Published: May 27, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2024-03-01/proximityplacementgroups Documentation

The proximityplacementgroups SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2024-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/compute/2024-03-01/proximityplacementgroups"

Client Initialization

client := proximityplacementgroups.NewProximityPlacementGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProximityPlacementGroupsClient.CreateOrUpdate

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

payload := proximityplacementgroups.ProximityPlacementGroup{
	// ...
}


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: ProximityPlacementGroupsClient.Delete

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

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

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

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

Example Usage: ProximityPlacementGroupsClient.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: ProximityPlacementGroupsClient.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: ProximityPlacementGroupsClient.Update

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

payload := proximityplacementgroups.UpdateResource{
	// ...
}


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 PossibleValuesForProximityPlacementGroupType 

func PossibleValuesForProximityPlacementGroupType() []string

func PossibleValuesForStatusLevelTypes 

func PossibleValuesForStatusLevelTypes() []string

func ValidateProximityPlacementGroupID 

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

ValidateProximityPlacementGroupID checks that 'input' can be parsed as a Proximity Placement Group ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	IncludeColocationStatus *string
}

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        *ProximityPlacementGroup
}

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 ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProximityPlacementGroup
}

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProximityPlacementGroup
}

type ListBySubscriptionOperationResponse 

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

type ProximityPlacementGroup 

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

type ProximityPlacementGroupId 

type ProximityPlacementGroupId struct {
	SubscriptionId              string
	ResourceGroupName           string
	ProximityPlacementGroupName string
}

ProximityPlacementGroupId is a struct representing the Resource ID for a Proximity Placement Group

func NewProximityPlacementGroupID 

func NewProximityPlacementGroupID(subscriptionId string, resourceGroupName string, proximityPlacementGroupName string) ProximityPlacementGroupId

NewProximityPlacementGroupID returns a new ProximityPlacementGroupId struct

func ParseProximityPlacementGroupID 

func ParseProximityPlacementGroupID(input string) (*ProximityPlacementGroupId, error)

ParseProximityPlacementGroupID parses 'input' into a ProximityPlacementGroupId

func ParseProximityPlacementGroupIDInsensitively 

func ParseProximityPlacementGroupIDInsensitively(input string) (*ProximityPlacementGroupId, error)

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

func (*ProximityPlacementGroupId) FromParseResult 

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

func (ProximityPlacementGroupId) ID 

func (id ProximityPlacementGroupId) ID() string

ID returns the formatted Proximity Placement Group ID

func (ProximityPlacementGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Proximity Placement Group ID

func (ProximityPlacementGroupId) String 

func (id ProximityPlacementGroupId) String() string

String returns a human-readable description of this Proximity Placement Group ID

type ProximityPlacementGroupOperationPredicate 

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

func (ProximityPlacementGroupOperationPredicate) Matches 

func (p ProximityPlacementGroupOperationPredicate) Matches(input ProximityPlacementGroup) bool

type ProximityPlacementGroupProperties 

type ProximityPlacementGroupProperties struct {
	AvailabilitySets            *[]SubResourceWithColocationStatus       `json:"availabilitySets,omitempty"`
	ColocationStatus            *InstanceViewStatus                      `json:"colocationStatus,omitempty"`
	Intent                      *ProximityPlacementGroupPropertiesIntent `json:"intent,omitempty"`
	ProximityPlacementGroupType *ProximityPlacementGroupType             `json:"proximityPlacementGroupType,omitempty"`
	VirtualMachineScaleSets     *[]SubResourceWithColocationStatus       `json:"virtualMachineScaleSets,omitempty"`
	VirtualMachines             *[]SubResourceWithColocationStatus       `json:"virtualMachines,omitempty"`
}

type ProximityPlacementGroupPropertiesIntent 

type ProximityPlacementGroupPropertiesIntent struct {
	VMSizes *[]string `json:"vmSizes,omitempty"`
}

type ProximityPlacementGroupType 

type ProximityPlacementGroupType string
const (
	ProximityPlacementGroupTypeStandard ProximityPlacementGroupType = "Standard"
	ProximityPlacementGroupTypeUltra    ProximityPlacementGroupType = "Ultra"
)

func (*ProximityPlacementGroupType) UnmarshalJSON 

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

type ProximityPlacementGroupsClient 

type ProximityPlacementGroupsClient struct {
	Client *resourcemanager.Client
}

func NewProximityPlacementGroupsClientWithBaseURI 

func NewProximityPlacementGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*ProximityPlacementGroupsClient, error)

func (ProximityPlacementGroupsClient) CreateOrUpdate 

func (c ProximityPlacementGroupsClient) CreateOrUpdate(ctx context.Context, id ProximityPlacementGroupId, input ProximityPlacementGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ProximityPlacementGroupsClient) Delete 

func (c ProximityPlacementGroupsClient) Delete(ctx context.Context, id ProximityPlacementGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (ProximityPlacementGroupsClient) Get 

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

Get ...

func (ProximityPlacementGroupsClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (ProximityPlacementGroupsClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (ProximityPlacementGroupsClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProximityPlacementGroupsClient) ListBySubscription 

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

ListBySubscription ...

func (ProximityPlacementGroupsClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (ProximityPlacementGroupsClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ProximityPlacementGroupsClient) Update 

func (c ProximityPlacementGroupsClient) Update(ctx context.Context, id ProximityPlacementGroupId, input UpdateResource) (result UpdateOperationResponse, err error)

Update ...

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 SubResourceWithColocationStatus 

type SubResourceWithColocationStatus struct {
	ColocationStatus *InstanceViewStatus `json:"colocationStatus,omitempty"`
	Id               *string             `json:"id,omitempty"`
}

type UpdateOperationResponse 

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

type UpdateResource 

type UpdateResource struct {
	Tags *map[string]string `json:"tags,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.