README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/hcxenterprisesites
Documentation
The hcxenterprisesites
SDK allows for interaction with the Azure Resource Manager Service vmware
(API Version 2022-05-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/2022-05-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", "privateCloudValue", "hcxEnterpriseSiteValue")
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", "privateCloudValue", "hcxEnterpriseSiteValue")
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", "privateCloudValue", "hcxEnterpriseSiteValue")
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", "privateCloudValue")
// 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 ¶
- func PossibleValuesForHcxEnterpriseSiteStatus() []string
- func ValidateHcxEnterpriseSiteID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateCloudID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type HcxEnterpriseSite
- type HcxEnterpriseSiteId
- type HcxEnterpriseSiteOperationPredicate
- type HcxEnterpriseSiteProperties
- type HcxEnterpriseSiteStatus
- type HcxEnterpriseSitesClient
- func (c HcxEnterpriseSitesClient) CreateOrUpdate(ctx context.Context, id HcxEnterpriseSiteId, input HcxEnterpriseSite) (result CreateOrUpdateOperationResponse, err error)
- func (c HcxEnterpriseSitesClient) Delete(ctx context.Context, id HcxEnterpriseSiteId) (result DeleteOperationResponse, err error)
- func (c HcxEnterpriseSitesClient) Get(ctx context.Context, id HcxEnterpriseSiteId) (result GetOperationResponse, err error)
- func (c HcxEnterpriseSitesClient) List(ctx context.Context, id PrivateCloudId) (resp ListOperationResponse, err error)
- func (c HcxEnterpriseSitesClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)
- func (c HcxEnterpriseSitesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, ...) (resp ListCompleteResult, err error)
- type ListCompleteResult
- type ListOperationResponse
- type PrivateCloudId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForHcxEnterpriseSiteStatus ¶
func PossibleValuesForHcxEnterpriseSiteStatus() []string
func ValidateHcxEnterpriseSiteID ¶
ValidateHcxEnterpriseSiteID checks that 'input' can be parsed as a Hcx Enterprise Site ID
func ValidatePrivateCloudID ¶
ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID
Types ¶
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *HcxEnterpriseSite }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *HcxEnterpriseSite }
type HcxEnterpriseSite ¶
type HcxEnterpriseSite struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *HcxEnterpriseSiteProperties `json:"properties,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) 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 ¶
func (HcxEnterpriseSiteOperationPredicate) Matches ¶
func (p HcxEnterpriseSiteOperationPredicate) Matches(input HcxEnterpriseSite) bool
type HcxEnterpriseSiteProperties ¶
type HcxEnterpriseSiteProperties struct { ActivationKey *string `json:"activationKey,omitempty"` Status *HcxEnterpriseSiteStatus `json:"status,omitempty"` }
type HcxEnterpriseSiteStatus ¶
type HcxEnterpriseSiteStatus string
const ( HcxEnterpriseSiteStatusAvailable HcxEnterpriseSiteStatus = "Available" HcxEnterpriseSiteStatusConsumed HcxEnterpriseSiteStatus = "Consumed" HcxEnterpriseSiteStatusDeactivated HcxEnterpriseSiteStatus = "Deactivated" HcxEnterpriseSiteStatusDeleted HcxEnterpriseSiteStatus = "Deleted" )
type HcxEnterpriseSitesClient ¶
type HcxEnterpriseSitesClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewHcxEnterpriseSitesClientWithBaseURI ¶
func NewHcxEnterpriseSitesClientWithBaseURI(endpoint string) HcxEnterpriseSitesClient
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) (resp ListOperationResponse, err error)
List ...
func (HcxEnterpriseSitesClient) ListComplete ¶
func (c HcxEnterpriseSitesClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (HcxEnterpriseSitesClient) ListCompleteMatchingPredicate ¶
func (c HcxEnterpriseSitesClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate HcxEnterpriseSiteOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []HcxEnterpriseSite
}
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]HcxEnterpriseSite // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
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) 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