privateclouds

package
v0.20240522.1080424 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/privateclouds Documentation

The privateclouds 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/privateclouds"

Client Initialization

client := privateclouds.NewPrivateCloudsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateCloudsClient.CreateOrUpdate

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

payload := privateclouds.PrivateCloud{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PrivateCloudsClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateCloudsClient.Get

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

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: PrivateCloudsClient.List

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

// 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
}

Example Usage: PrivateCloudsClient.ListAdminCredentials

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

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

Example Usage: PrivateCloudsClient.ListInSubscription

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

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

Example Usage: PrivateCloudsClient.RotateNsxtPassword

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

if err := client.RotateNsxtPasswordThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateCloudsClient.RotateVcenterPassword

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

if err := client.RotateVcenterPasswordThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateCloudsClient.Update

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

payload := privateclouds.PrivateCloudUpdate{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAvailabilityStrategy 

func PossibleValuesForAvailabilityStrategy() []string

func PossibleValuesForClusterProvisioningState 

func PossibleValuesForClusterProvisioningState() []string

func PossibleValuesForEncryptionKeyStatus 

func PossibleValuesForEncryptionKeyStatus() []string

func PossibleValuesForEncryptionState 

func PossibleValuesForEncryptionState() []string

func PossibleValuesForEncryptionVersionType 

func PossibleValuesForEncryptionVersionType() []string

func PossibleValuesForInternetEnum 

func PossibleValuesForInternetEnum() []string

func PossibleValuesForNsxPublicIPQuotaRaisedEnum 

func PossibleValuesForNsxPublicIPQuotaRaisedEnum() []string

func PossibleValuesForPrivateCloudProvisioningState 

func PossibleValuesForPrivateCloudProvisioningState() []string

func PossibleValuesForSslEnum 

func PossibleValuesForSslEnum() []string

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 AdminCredentials 

type AdminCredentials struct {
	NsxtPassword    *string `json:"nsxtPassword,omitempty"`
	NsxtUsername    *string `json:"nsxtUsername,omitempty"`
	VcenterPassword *string `json:"vcenterPassword,omitempty"`
	VcenterUsername *string `json:"vcenterUsername,omitempty"`
}

type AvailabilityProperties 

type AvailabilityProperties struct {
	SecondaryZone *int64                `json:"secondaryZone,omitempty"`
	Strategy      *AvailabilityStrategy `json:"strategy,omitempty"`
	Zone          *int64                `json:"zone,omitempty"`
}

type AvailabilityStrategy 

type AvailabilityStrategy string
const (
	AvailabilityStrategyDualZone   AvailabilityStrategy = "DualZone"
	AvailabilityStrategySingleZone AvailabilityStrategy = "SingleZone"
)

func (*AvailabilityStrategy) UnmarshalJSON 

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

type Circuit 

type Circuit struct {
	ExpressRouteID               *string `json:"expressRouteID,omitempty"`
	ExpressRoutePrivatePeeringID *string `json:"expressRoutePrivatePeeringID,omitempty"`
	PrimarySubnet                *string `json:"primarySubnet,omitempty"`
	SecondarySubnet              *string `json:"secondarySubnet,omitempty"`
}

type ClusterProvisioningState 

type ClusterProvisioningState string
const (
	ClusterProvisioningStateCanceled  ClusterProvisioningState = "Canceled"
	ClusterProvisioningStateCancelled ClusterProvisioningState = "Cancelled"
	ClusterProvisioningStateDeleting  ClusterProvisioningState = "Deleting"
	ClusterProvisioningStateFailed    ClusterProvisioningState = "Failed"
	ClusterProvisioningStateSucceeded ClusterProvisioningState = "Succeeded"
	ClusterProvisioningStateUpdating  ClusterProvisioningState = "Updating"
)

func (*ClusterProvisioningState) UnmarshalJSON 

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

type CommonClusterProperties 

type CommonClusterProperties struct {
	ClusterId         *int64                    `json:"clusterId,omitempty"`
	ClusterSize       *int64                    `json:"clusterSize,omitempty"`
	Hosts             *[]string                 `json:"hosts,omitempty"`
	ProvisioningState *ClusterProvisioningState `json:"provisioningState,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateCloud
}

type DeleteOperationResponse 

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

type Encryption 

type Encryption struct {
	KeyVaultProperties *EncryptionKeyVaultProperties `json:"keyVaultProperties,omitempty"`
	Status             *EncryptionState              `json:"status,omitempty"`
}

type EncryptionKeyStatus 

type EncryptionKeyStatus string
const (
	EncryptionKeyStatusAccessDenied EncryptionKeyStatus = "AccessDenied"
	EncryptionKeyStatusConnected    EncryptionKeyStatus = "Connected"
)

func (*EncryptionKeyStatus) UnmarshalJSON 

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

type EncryptionKeyVaultProperties 

type EncryptionKeyVaultProperties struct {
	AutoDetectedKeyVersion *string                `json:"autoDetectedKeyVersion,omitempty"`
	KeyName                *string                `json:"keyName,omitempty"`
	KeyState               *EncryptionKeyStatus   `json:"keyState,omitempty"`
	KeyVaultUrl            *string                `json:"keyVaultUrl,omitempty"`
	KeyVersion             *string                `json:"keyVersion,omitempty"`
	VersionType            *EncryptionVersionType `json:"versionType,omitempty"`
}

type EncryptionState 

type EncryptionState string
const (
	EncryptionStateDisabled EncryptionState = "Disabled"
	EncryptionStateEnabled  EncryptionState = "Enabled"
)

func (*EncryptionState) UnmarshalJSON 

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

type EncryptionVersionType 

type EncryptionVersionType string
const (
	EncryptionVersionTypeAutoDetected EncryptionVersionType = "AutoDetected"
	EncryptionVersionTypeFixed        EncryptionVersionType = "Fixed"
)

func (*EncryptionVersionType) UnmarshalJSON 

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

type Endpoints 

type Endpoints struct {
	HcxCloudManager *string `json:"hcxCloudManager,omitempty"`
	NsxtManager     *string `json:"nsxtManager,omitempty"`
	Vcsa            *string `json:"vcsa,omitempty"`
}

type GetOperationResponse 

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

type IdentitySource 

type IdentitySource struct {
	Alias           *string  `json:"alias,omitempty"`
	BaseGroupDN     *string  `json:"baseGroupDN,omitempty"`
	BaseUserDN      *string  `json:"baseUserDN,omitempty"`
	Domain          *string  `json:"domain,omitempty"`
	Name            *string  `json:"name,omitempty"`
	Password        *string  `json:"password,omitempty"`
	PrimaryServer   *string  `json:"primaryServer,omitempty"`
	SecondaryServer *string  `json:"secondaryServer,omitempty"`
	Ssl             *SslEnum `json:"ssl,omitempty"`
	Username        *string  `json:"username,omitempty"`
}

type InternetEnum 

type InternetEnum string
const (
	InternetEnumDisabled InternetEnum = "Disabled"
	InternetEnumEnabled  InternetEnum = "Enabled"
)

func (*InternetEnum) UnmarshalJSON 

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

type ListAdminCredentialsOperationResponse 

type ListAdminCredentialsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AdminCredentials
}

type ListCompleteResult 

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

type ListInSubscriptionCompleteResult 

type ListInSubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateCloud
}

type ListInSubscriptionOperationResponse 

type ListInSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateCloud
}

type ListOperationResponse 

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

type NsxPublicIPQuotaRaisedEnum 

type NsxPublicIPQuotaRaisedEnum string
const (
	NsxPublicIPQuotaRaisedEnumDisabled NsxPublicIPQuotaRaisedEnum = "Disabled"
	NsxPublicIPQuotaRaisedEnumEnabled  NsxPublicIPQuotaRaisedEnum = "Enabled"
)

func (*NsxPublicIPQuotaRaisedEnum) UnmarshalJSON 

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

type PrivateCloud 

type PrivateCloud struct {
	Id         *string                  `json:"id,omitempty"`
	Identity   *identity.SystemAssigned `json:"identity,omitempty"`
	Location   *string                  `json:"location,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *PrivateCloudProperties  `json:"properties,omitempty"`
	Sku        Sku                      `json:"sku"`
	Tags       *map[string]string       `json:"tags,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

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

type PrivateCloudOperationPredicate 

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

func (PrivateCloudOperationPredicate) Matches 

func (p PrivateCloudOperationPredicate) Matches(input PrivateCloud) bool

type PrivateCloudProperties 

type PrivateCloudProperties struct {
	Availability                 *AvailabilityProperties        `json:"availability,omitempty"`
	Circuit                      *Circuit                       `json:"circuit,omitempty"`
	Encryption                   *Encryption                    `json:"encryption,omitempty"`
	Endpoints                    *Endpoints                     `json:"endpoints,omitempty"`
	ExternalCloudLinks           *[]string                      `json:"externalCloudLinks,omitempty"`
	IdentitySources              *[]IdentitySource              `json:"identitySources,omitempty"`
	Internet                     *InternetEnum                  `json:"internet,omitempty"`
	ManagementCluster            *CommonClusterProperties       `json:"managementCluster,omitempty"`
	ManagementNetwork            *string                        `json:"managementNetwork,omitempty"`
	NetworkBlock                 string                         `json:"networkBlock"`
	NsxPublicIPQuotaRaised       *NsxPublicIPQuotaRaisedEnum    `json:"nsxPublicIpQuotaRaised,omitempty"`
	NsxtCertificateThumbprint    *string                        `json:"nsxtCertificateThumbprint,omitempty"`
	NsxtPassword                 *string                        `json:"nsxtPassword,omitempty"`
	ProvisioningNetwork          *string                        `json:"provisioningNetwork,omitempty"`
	ProvisioningState            *PrivateCloudProvisioningState `json:"provisioningState,omitempty"`
	SecondaryCircuit             *Circuit                       `json:"secondaryCircuit,omitempty"`
	VMotionNetwork               *string                        `json:"vmotionNetwork,omitempty"`
	VcenterCertificateThumbprint *string                        `json:"vcenterCertificateThumbprint,omitempty"`
	VcenterPassword              *string                        `json:"vcenterPassword,omitempty"`
}

type PrivateCloudProvisioningState 

type PrivateCloudProvisioningState string
const (
	PrivateCloudProvisioningStateBuilding  PrivateCloudProvisioningState = "Building"
	PrivateCloudProvisioningStateCanceled  PrivateCloudProvisioningState = "Canceled"
	PrivateCloudProvisioningStateCancelled PrivateCloudProvisioningState = "Cancelled"
	PrivateCloudProvisioningStateDeleting  PrivateCloudProvisioningState = "Deleting"
	PrivateCloudProvisioningStateFailed    PrivateCloudProvisioningState = "Failed"
	PrivateCloudProvisioningStatePending   PrivateCloudProvisioningState = "Pending"
	PrivateCloudProvisioningStateSucceeded PrivateCloudProvisioningState = "Succeeded"
	PrivateCloudProvisioningStateUpdating  PrivateCloudProvisioningState = "Updating"
)

func (*PrivateCloudProvisioningState) UnmarshalJSON 

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

type PrivateCloudUpdate 

type PrivateCloudUpdate struct {
	Identity   *identity.SystemAssigned      `json:"identity,omitempty"`
	Properties *PrivateCloudUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
}

type PrivateCloudUpdateProperties 

type PrivateCloudUpdateProperties struct {
	Availability      *AvailabilityProperties  `json:"availability,omitempty"`
	Encryption        *Encryption              `json:"encryption,omitempty"`
	IdentitySources   *[]IdentitySource        `json:"identitySources,omitempty"`
	Internet          *InternetEnum            `json:"internet,omitempty"`
	ManagementCluster *CommonClusterProperties `json:"managementCluster,omitempty"`
}

type PrivateCloudsClient 

type PrivateCloudsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateCloudsClientWithBaseURI 

func NewPrivateCloudsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateCloudsClient, error)

func (PrivateCloudsClient) CreateOrUpdate 

func (c PrivateCloudsClient) CreateOrUpdate(ctx context.Context, id PrivateCloudId, input PrivateCloud) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateCloudsClient) CreateOrUpdateThenPoll 

func (c PrivateCloudsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateCloudId, input PrivateCloud) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PrivateCloudsClient) Delete 

func (c PrivateCloudsClient) Delete(ctx context.Context, id PrivateCloudId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateCloudsClient) DeleteThenPoll 

func (c PrivateCloudsClient) DeleteThenPoll(ctx context.Context, id PrivateCloudId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateCloudsClient) Get 

func (c PrivateCloudsClient) Get(ctx context.Context, id PrivateCloudId) (result GetOperationResponse, err error)

Get ...

func (PrivateCloudsClient) List 

func (c PrivateCloudsClient) List(ctx context.Context, id commonids.ResourceGroupId) (result ListOperationResponse, err error)

List ...

func (PrivateCloudsClient) ListAdminCredentials 

func (c PrivateCloudsClient) ListAdminCredentials(ctx context.Context, id PrivateCloudId) (result ListAdminCredentialsOperationResponse, err error)

ListAdminCredentials ...

func (PrivateCloudsClient) ListComplete 

func (c PrivateCloudsClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateCloudsClient) ListCompleteMatchingPredicate 

func (c PrivateCloudsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PrivateCloudOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateCloudsClient) ListInSubscription 

func (c PrivateCloudsClient) ListInSubscription(ctx context.Context, id commonids.SubscriptionId) (result ListInSubscriptionOperationResponse, err error)

ListInSubscription ...

func (PrivateCloudsClient) ListInSubscriptionComplete 

func (c PrivateCloudsClient) ListInSubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListInSubscriptionCompleteResult, error)

ListInSubscriptionComplete retrieves all the results into a single object

func (PrivateCloudsClient) ListInSubscriptionCompleteMatchingPredicate 

func (c PrivateCloudsClient) ListInSubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate PrivateCloudOperationPredicate) (result ListInSubscriptionCompleteResult, err error)

ListInSubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateCloudsClient) RotateNsxtPassword 

func (c PrivateCloudsClient) RotateNsxtPassword(ctx context.Context, id PrivateCloudId) (result RotateNsxtPasswordOperationResponse, err error)

RotateNsxtPassword ...

func (PrivateCloudsClient) RotateNsxtPasswordThenPoll 

func (c PrivateCloudsClient) RotateNsxtPasswordThenPoll(ctx context.Context, id PrivateCloudId) error

RotateNsxtPasswordThenPoll performs RotateNsxtPassword then polls until it's completed

func (PrivateCloudsClient) RotateVcenterPassword 

func (c PrivateCloudsClient) RotateVcenterPassword(ctx context.Context, id PrivateCloudId) (result RotateVcenterPasswordOperationResponse, err error)

RotateVcenterPassword ...

func (PrivateCloudsClient) RotateVcenterPasswordThenPoll 

func (c PrivateCloudsClient) RotateVcenterPasswordThenPoll(ctx context.Context, id PrivateCloudId) error

RotateVcenterPasswordThenPoll performs RotateVcenterPassword then polls until it's completed

func (PrivateCloudsClient) Update 

func (c PrivateCloudsClient) Update(ctx context.Context, id PrivateCloudId, input PrivateCloudUpdate) (result UpdateOperationResponse, err error)

Update ...

func (PrivateCloudsClient) UpdateThenPoll 

func (c PrivateCloudsClient) UpdateThenPoll(ctx context.Context, id PrivateCloudId, input PrivateCloudUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type RotateNsxtPasswordOperationResponse 

type RotateNsxtPasswordOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type RotateVcenterPasswordOperationResponse 

type RotateVcenterPasswordOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Sku 

type Sku struct {
	Name string `json:"name"`
}

type SslEnum 

type SslEnum string
const (
	SslEnumDisabled SslEnum = "Disabled"
	SslEnumEnabled  SslEnum = "Enabled"
)

func (*SslEnum) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateCloud
}

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.