hcxenterprisesites

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/hcxenterprisesites Documentation

The hcxenterprisesites SDK allows for interaction with Azure Resource Manager vmware (API Version 2023-09-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/vmware/2023-09-01/hcxenterprisesites"

Client Initialization

client := hcxenterprisesites.NewHcxEnterpriseSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HcxEnterpriseSitesClient.CreateOrUpdate

ctx := context.TODO()
id := hcxenterprisesites.NewHcxEnterpriseSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "hcxEnterpriseSiteName")

payload := hcxenterprisesites.HcxEnterpriseSite{
	// ...
}


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

ctx := context.TODO()
id := hcxenterprisesites.NewHcxEnterpriseSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "hcxEnterpriseSiteName")

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

ctx := context.TODO()
id := hcxenterprisesites.NewHcxEnterpriseSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudName", "hcxEnterpriseSiteName")

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

Example Usage: HcxEnterpriseSitesClient.List

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForHcxEnterpriseSiteProvisioningState 

func PossibleValuesForHcxEnterpriseSiteProvisioningState() []string

func PossibleValuesForHcxEnterpriseSiteStatus 

func PossibleValuesForHcxEnterpriseSiteStatus() []string

func ValidateHcxEnterpriseSiteID 

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

ValidateHcxEnterpriseSiteID checks that 'input' can be parsed as a Hcx Enterprise Site ID

func ValidatePrivateCloudID 

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

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type HcxEnterpriseSite 

type HcxEnterpriseSite struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *HcxEnterpriseSiteProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type HcxEnterpriseSiteId 

type HcxEnterpriseSiteId struct {
	SubscriptionId        string
	ResourceGroupName     string
	PrivateCloudName      string
	HcxEnterpriseSiteName string
}

HcxEnterpriseSiteId is a struct representing the Resource ID for a Hcx Enterprise Site

func NewHcxEnterpriseSiteID 

func NewHcxEnterpriseSiteID(subscriptionId string, resourceGroupName string, privateCloudName string, hcxEnterpriseSiteName string) HcxEnterpriseSiteId

NewHcxEnterpriseSiteID returns a new HcxEnterpriseSiteId struct

func ParseHcxEnterpriseSiteID 

func ParseHcxEnterpriseSiteID(input string) (*HcxEnterpriseSiteId, error)

ParseHcxEnterpriseSiteID parses 'input' into a HcxEnterpriseSiteId

func ParseHcxEnterpriseSiteIDInsensitively 

func ParseHcxEnterpriseSiteIDInsensitively(input string) (*HcxEnterpriseSiteId, error)

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

func (*HcxEnterpriseSiteId) FromParseResult 

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

func (HcxEnterpriseSiteId) ID 

func (id HcxEnterpriseSiteId) ID() string

ID returns the formatted Hcx Enterprise Site ID

func (HcxEnterpriseSiteId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Hcx Enterprise Site ID

func (HcxEnterpriseSiteId) String 

func (id HcxEnterpriseSiteId) String() string

String returns a human-readable description of this Hcx Enterprise Site ID

type HcxEnterpriseSiteOperationPredicate 

type HcxEnterpriseSiteOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (HcxEnterpriseSiteOperationPredicate) Matches 

func (p HcxEnterpriseSiteOperationPredicate) Matches(input HcxEnterpriseSite) bool

type HcxEnterpriseSiteProperties 

type HcxEnterpriseSiteProperties struct {
	ActivationKey     *string                             `json:"activationKey,omitempty"`
	ProvisioningState *HcxEnterpriseSiteProvisioningState `json:"provisioningState,omitempty"`
	Status            *HcxEnterpriseSiteStatus            `json:"status,omitempty"`
}

type HcxEnterpriseSiteProvisioningState 

type HcxEnterpriseSiteProvisioningState string
const (
	HcxEnterpriseSiteProvisioningStateCanceled  HcxEnterpriseSiteProvisioningState = "Canceled"
	HcxEnterpriseSiteProvisioningStateFailed    HcxEnterpriseSiteProvisioningState = "Failed"
	HcxEnterpriseSiteProvisioningStateSucceeded HcxEnterpriseSiteProvisioningState = "Succeeded"
)

func (*HcxEnterpriseSiteProvisioningState) UnmarshalJSON 

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

type HcxEnterpriseSiteStatus 

type HcxEnterpriseSiteStatus string
const (
	HcxEnterpriseSiteStatusAvailable   HcxEnterpriseSiteStatus = "Available"
	HcxEnterpriseSiteStatusConsumed    HcxEnterpriseSiteStatus = "Consumed"
	HcxEnterpriseSiteStatusDeactivated HcxEnterpriseSiteStatus = "Deactivated"
	HcxEnterpriseSiteStatusDeleted     HcxEnterpriseSiteStatus = "Deleted"
)

func (*HcxEnterpriseSiteStatus) UnmarshalJSON 

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

type HcxEnterpriseSitesClient 

type HcxEnterpriseSitesClient struct {
	Client *resourcemanager.Client
}

func NewHcxEnterpriseSitesClientWithBaseURI 

func NewHcxEnterpriseSitesClientWithBaseURI(sdkApi sdkEnv.Api) (*HcxEnterpriseSitesClient, error)

func (HcxEnterpriseSitesClient) CreateOrUpdate 

func (c HcxEnterpriseSitesClient) CreateOrUpdate(ctx context.Context, id HcxEnterpriseSiteId, input HcxEnterpriseSite) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (HcxEnterpriseSitesClient) Delete 

func (c HcxEnterpriseSitesClient) Delete(ctx context.Context, id HcxEnterpriseSiteId) (result DeleteOperationResponse, err error)

Delete ...

func (HcxEnterpriseSitesClient) Get 

func (c HcxEnterpriseSitesClient) Get(ctx context.Context, id HcxEnterpriseSiteId) (result GetOperationResponse, err error)

Get ...

func (HcxEnterpriseSitesClient) List 

func (c HcxEnterpriseSitesClient) List(ctx context.Context, id PrivateCloudId) (result ListOperationResponse, err error)

List ...

func (HcxEnterpriseSitesClient) ListComplete 

func (c HcxEnterpriseSitesClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (HcxEnterpriseSitesClient) ListCompleteMatchingPredicate 

func (c HcxEnterpriseSitesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate HcxEnterpriseSiteOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HcxEnterpriseSite
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HcxEnterpriseSite
}

type PrivateCloudId 

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID 

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID 

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively 

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

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

func (*PrivateCloudId) FromParseResult 

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

func (PrivateCloudId) ID 

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String 

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud ID

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.