cloudvmclusters

package
v0.20240903.1131440 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/cloudvmclusters Documentation

The cloudvmclusters SDK allows for interaction with the Azure Resource Manager Service oracledatabase (API Version 2024-06-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/oracledatabase/2024-06-01/cloudvmclusters"

Client Initialization

client := cloudvmclusters.NewCloudVMClustersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CloudVMClustersClient.AddVMs

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

payload := cloudvmclusters.AddRemoveDbNode{
	// ...
}


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

Example Usage: CloudVMClustersClient.CreateOrUpdate

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

payload := cloudvmclusters.CloudVMCluster{
	// ...
}


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

Example Usage: CloudVMClustersClient.Delete

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

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

Example Usage: CloudVMClustersClient.Get

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

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: CloudVMClustersClient.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: CloudVMClustersClient.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: CloudVMClustersClient.ListPrivateIPAddresses

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

payload := cloudvmclusters.PrivateIPAddressesFilter{
	// ...
}


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

Example Usage: CloudVMClustersClient.RemoveVMs

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

payload := cloudvmclusters.AddRemoveDbNode{
	// ...
}


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

Example Usage: CloudVMClustersClient.Update

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

payload := cloudvmclusters.CloudVMClusterUpdate{
	// ...
}


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 PossibleValuesForAzureResourceProvisioningState

func PossibleValuesForAzureResourceProvisioningState() []string

func PossibleValuesForCloudVMClusterLifecycleState

func PossibleValuesForCloudVMClusterLifecycleState() []string

func PossibleValuesForDiskRedundancy

func PossibleValuesForDiskRedundancy() []string

func PossibleValuesForIormLifecycleState

func PossibleValuesForIormLifecycleState() []string

func PossibleValuesForLicenseModel

func PossibleValuesForLicenseModel() []string

func PossibleValuesForObjective

func PossibleValuesForObjective() []string

func ValidateCloudVMClusterID

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

ValidateCloudVMClusterID checks that 'input' can be parsed as a Cloud V M Cluster ID

Types

type AddRemoveDbNode

type AddRemoveDbNode struct {
	DbServers []string `json:"dbServers"`
}

type AddVMsOperationResponse

type AddVMsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudVMCluster
}

type AzureResourceProvisioningState

type AzureResourceProvisioningState string
const (
	AzureResourceProvisioningStateCanceled     AzureResourceProvisioningState = "Canceled"
	AzureResourceProvisioningStateFailed       AzureResourceProvisioningState = "Failed"
	AzureResourceProvisioningStateProvisioning AzureResourceProvisioningState = "Provisioning"
	AzureResourceProvisioningStateSucceeded    AzureResourceProvisioningState = "Succeeded"
)

func (*AzureResourceProvisioningState) UnmarshalJSON

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

type CloudVMCluster

type CloudVMCluster struct {
	Id         *string                   `json:"id,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *CloudVMClusterProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type CloudVMClusterId

type CloudVMClusterId struct {
	SubscriptionId     string
	ResourceGroupName  string
	CloudVmClusterName string
}

CloudVMClusterId is a struct representing the Resource ID for a Cloud V M Cluster

func NewCloudVMClusterID

func NewCloudVMClusterID(subscriptionId string, resourceGroupName string, cloudVmClusterName string) CloudVMClusterId

NewCloudVMClusterID returns a new CloudVMClusterId struct

func ParseCloudVMClusterID

func ParseCloudVMClusterID(input string) (*CloudVMClusterId, error)

ParseCloudVMClusterID parses 'input' into a CloudVMClusterId

func ParseCloudVMClusterIDInsensitively

func ParseCloudVMClusterIDInsensitively(input string) (*CloudVMClusterId, error)

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

func (*CloudVMClusterId) FromParseResult

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

func (CloudVMClusterId) ID

func (id CloudVMClusterId) ID() string

ID returns the formatted Cloud V M Cluster ID

func (CloudVMClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Cloud V M Cluster ID

func (CloudVMClusterId) String

func (id CloudVMClusterId) String() string

String returns a human-readable description of this Cloud V M Cluster ID

type CloudVMClusterLifecycleState

type CloudVMClusterLifecycleState string
const (
	CloudVMClusterLifecycleStateAvailable             CloudVMClusterLifecycleState = "Available"
	CloudVMClusterLifecycleStateFailed                CloudVMClusterLifecycleState = "Failed"
	CloudVMClusterLifecycleStateMaintenanceInProgress CloudVMClusterLifecycleState = "MaintenanceInProgress"
	CloudVMClusterLifecycleStateProvisioning          CloudVMClusterLifecycleState = "Provisioning"
	CloudVMClusterLifecycleStateTerminated            CloudVMClusterLifecycleState = "Terminated"
	CloudVMClusterLifecycleStateTerminating           CloudVMClusterLifecycleState = "Terminating"
	CloudVMClusterLifecycleStateUpdating              CloudVMClusterLifecycleState = "Updating"
)

func (*CloudVMClusterLifecycleState) UnmarshalJSON

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

type CloudVMClusterOperationPredicate

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

func (CloudVMClusterOperationPredicate) Matches

type CloudVMClusterProperties

type CloudVMClusterProperties struct {
	BackupSubnetCidr             *string                         `json:"backupSubnetCidr,omitempty"`
	CloudExadataInfrastructureId string                          `json:"cloudExadataInfrastructureId"`
	ClusterName                  *string                         `json:"clusterName,omitempty"`
	CompartmentId                *string                         `json:"compartmentId,omitempty"`
	ComputeNodes                 *[]string                       `json:"computeNodes,omitempty"`
	CpuCoreCount                 int64                           `json:"cpuCoreCount"`
	DataCollectionOptions        *DataCollectionOptions          `json:"dataCollectionOptions,omitempty"`
	DataStoragePercentage        *int64                          `json:"dataStoragePercentage,omitempty"`
	DataStorageSizeInTbs         *float64                        `json:"dataStorageSizeInTbs,omitempty"`
	DbNodeStorageSizeInGbs       *int64                          `json:"dbNodeStorageSizeInGbs,omitempty"`
	DbServers                    *[]string                       `json:"dbServers,omitempty"`
	DiskRedundancy               *DiskRedundancy                 `json:"diskRedundancy,omitempty"`
	DisplayName                  string                          `json:"displayName"`
	Domain                       *string                         `json:"domain,omitempty"`
	GiVersion                    string                          `json:"giVersion"`
	Hostname                     string                          `json:"hostname"`
	IormConfigCache              *ExadataIormConfig              `json:"iormConfigCache,omitempty"`
	IsLocalBackupEnabled         *bool                           `json:"isLocalBackupEnabled,omitempty"`
	IsSparseDiskgroupEnabled     *bool                           `json:"isSparseDiskgroupEnabled,omitempty"`
	LastUpdateHistoryEntryId     *string                         `json:"lastUpdateHistoryEntryId,omitempty"`
	LicenseModel                 *LicenseModel                   `json:"licenseModel,omitempty"`
	LifecycleDetails             *string                         `json:"lifecycleDetails,omitempty"`
	LifecycleState               *CloudVMClusterLifecycleState   `json:"lifecycleState,omitempty"`
	ListenerPort                 *int64                          `json:"listenerPort,omitempty"`
	MemorySizeInGbs              *int64                          `json:"memorySizeInGbs,omitempty"`
	NodeCount                    *int64                          `json:"nodeCount,omitempty"`
	NsgCidrs                     *[]NsgCidr                      `json:"nsgCidrs,omitempty"`
	NsgUrl                       *string                         `json:"nsgUrl,omitempty"`
	OciUrl                       *string                         `json:"ociUrl,omitempty"`
	Ocid                         *string                         `json:"ocid,omitempty"`
	OcpuCount                    *float64                        `json:"ocpuCount,omitempty"`
	ProvisioningState            *AzureResourceProvisioningState `json:"provisioningState,omitempty"`
	ScanDnsName                  *string                         `json:"scanDnsName,omitempty"`
	ScanDnsRecordId              *string                         `json:"scanDnsRecordId,omitempty"`
	ScanIPIds                    *[]string                       `json:"scanIpIds,omitempty"`
	ScanListenerPortTcp          *int64                          `json:"scanListenerPortTcp,omitempty"`
	ScanListenerPortTcpSsl       *int64                          `json:"scanListenerPortTcpSsl,omitempty"`
	Shape                        *string                         `json:"shape,omitempty"`
	SshPublicKeys                []string                        `json:"sshPublicKeys"`
	StorageSizeInGbs             *int64                          `json:"storageSizeInGbs,omitempty"`
	SubnetId                     string                          `json:"subnetId"`
	SubnetOcid                   *string                         `json:"subnetOcid,omitempty"`
	SystemVersion                *string                         `json:"systemVersion,omitempty"`
	TimeCreated                  *string                         `json:"timeCreated,omitempty"`
	TimeZone                     *string                         `json:"timeZone,omitempty"`
	VipIds                       *[]string                       `json:"vipIds,omitempty"`
	VnetId                       string                          `json:"vnetId"`
	ZoneId                       *string                         `json:"zoneId,omitempty"`
}

func (*CloudVMClusterProperties) GetTimeCreatedAsTime

func (o *CloudVMClusterProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*CloudVMClusterProperties) SetTimeCreatedAsTime

func (o *CloudVMClusterProperties) SetTimeCreatedAsTime(input time.Time)

type CloudVMClusterUpdate

type CloudVMClusterUpdate struct {
	Properties *CloudVMClusterUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
}

type CloudVMClusterUpdateProperties

type CloudVMClusterUpdateProperties struct {
	ComputeNodes           *[]string              `json:"computeNodes,omitempty"`
	CpuCoreCount           *int64                 `json:"cpuCoreCount,omitempty"`
	DataCollectionOptions  *DataCollectionOptions `json:"dataCollectionOptions,omitempty"`
	DataStorageSizeInTbs   *float64               `json:"dataStorageSizeInTbs,omitempty"`
	DbNodeStorageSizeInGbs *int64                 `json:"dbNodeStorageSizeInGbs,omitempty"`
	DisplayName            *string                `json:"displayName,omitempty"`
	LicenseModel           *LicenseModel          `json:"licenseModel,omitempty"`
	MemorySizeInGbs        *int64                 `json:"memorySizeInGbs,omitempty"`
	OcpuCount              *float64               `json:"ocpuCount,omitempty"`
	SshPublicKeys          *[]string              `json:"sshPublicKeys,omitempty"`
	StorageSizeInGbs       *int64                 `json:"storageSizeInGbs,omitempty"`
}

type CloudVMClustersClient

type CloudVMClustersClient struct {
	Client *resourcemanager.Client
}

func NewCloudVMClustersClientWithBaseURI

func NewCloudVMClustersClientWithBaseURI(sdkApi sdkEnv.Api) (*CloudVMClustersClient, error)

func (CloudVMClustersClient) AddVMs

AddVMs ...

func (CloudVMClustersClient) AddVMsThenPoll

AddVMsThenPoll performs AddVMs then polls until it's completed

func (CloudVMClustersClient) CreateOrUpdate

CreateOrUpdate ...

func (CloudVMClustersClient) CreateOrUpdateThenPoll

func (c CloudVMClustersClient) CreateOrUpdateThenPoll(ctx context.Context, id CloudVMClusterId, input CloudVMCluster) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (CloudVMClustersClient) Delete

Delete ...

func (CloudVMClustersClient) DeleteThenPoll

func (c CloudVMClustersClient) DeleteThenPoll(ctx context.Context, id CloudVMClusterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (CloudVMClustersClient) Get

Get ...

func (CloudVMClustersClient) ListByResourceGroup

ListByResourceGroup ...

func (CloudVMClustersClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (CloudVMClustersClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CloudVMClustersClient) ListBySubscription

ListBySubscription ...

func (CloudVMClustersClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (CloudVMClustersClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CloudVMClustersClient) ListPrivateIPAddresses

ListPrivateIPAddresses ...

func (CloudVMClustersClient) RemoveVMs

RemoveVMs ...

func (CloudVMClustersClient) RemoveVMsThenPoll

func (c CloudVMClustersClient) RemoveVMsThenPoll(ctx context.Context, id CloudVMClusterId, input AddRemoveDbNode) error

RemoveVMsThenPoll performs RemoveVMs then polls until it's completed

func (CloudVMClustersClient) Update

Update ...

func (CloudVMClustersClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type CreateOrUpdateOperationResponse

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

type DataCollectionOptions

type DataCollectionOptions struct {
	IsDiagnosticsEventsEnabled *bool `json:"isDiagnosticsEventsEnabled,omitempty"`
	IsHealthMonitoringEnabled  *bool `json:"isHealthMonitoringEnabled,omitempty"`
	IsIncidentLogsEnabled      *bool `json:"isIncidentLogsEnabled,omitempty"`
}

type DbIormConfig

type DbIormConfig struct {
	DbName          *string `json:"dbName,omitempty"`
	FlashCacheLimit *string `json:"flashCacheLimit,omitempty"`
	Share           *int64  `json:"share,omitempty"`
}

type DeleteOperationResponse

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

type DiskRedundancy

type DiskRedundancy string
const (
	DiskRedundancyHigh   DiskRedundancy = "High"
	DiskRedundancyNormal DiskRedundancy = "Normal"
)

func (*DiskRedundancy) UnmarshalJSON

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

type ExadataIormConfig

type ExadataIormConfig struct {
	DbPlans          *[]DbIormConfig     `json:"dbPlans,omitempty"`
	LifecycleDetails *string             `json:"lifecycleDetails,omitempty"`
	LifecycleState   *IormLifecycleState `json:"lifecycleState,omitempty"`
	Objective        *Objective          `json:"objective,omitempty"`
}

type GetOperationResponse

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

type IormLifecycleState

type IormLifecycleState string
const (
	IormLifecycleStateBootStrapping IormLifecycleState = "BootStrapping"
	IormLifecycleStateDisabled      IormLifecycleState = "Disabled"
	IormLifecycleStateEnabled       IormLifecycleState = "Enabled"
	IormLifecycleStateFailed        IormLifecycleState = "Failed"
	IormLifecycleStateUpdating      IormLifecycleState = "Updating"
)

func (*IormLifecycleState) UnmarshalJSON

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

type LicenseModel

type LicenseModel string
const (
	LicenseModelBringYourOwnLicense LicenseModel = "BringYourOwnLicense"
	LicenseModelLicenseIncluded     LicenseModel = "LicenseIncluded"
)

func (*LicenseModel) UnmarshalJSON

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupCustomPager

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

type ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

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

type ListBySubscriptionCustomPager

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

type ListBySubscriptionOperationResponse

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

type ListPrivateIPAddressesOperationResponse

type ListPrivateIPAddressesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateIPAddressProperties
}

type NsgCidr

type NsgCidr struct {
	DestinationPortRange *PortRange `json:"destinationPortRange,omitempty"`
	Source               string     `json:"source"`
}

type Objective

type Objective string
const (
	ObjectiveAuto           Objective = "Auto"
	ObjectiveBalanced       Objective = "Balanced"
	ObjectiveBasic          Objective = "Basic"
	ObjectiveHighThroughput Objective = "HighThroughput"
	ObjectiveLowLatency     Objective = "LowLatency"
)

func (*Objective) UnmarshalJSON

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

type PortRange

type PortRange struct {
	Max int64 `json:"max"`
	Min int64 `json:"min"`
}

type PrivateIPAddressProperties

type PrivateIPAddressProperties struct {
	DisplayName   string `json:"displayName"`
	HostnameLabel string `json:"hostnameLabel"`
	IPAddress     string `json:"ipAddress"`
	Ocid          string `json:"ocid"`
	SubnetId      string `json:"subnetId"`
}

type PrivateIPAddressesFilter

type PrivateIPAddressesFilter struct {
	SubnetId string `json:"subnetId"`
	VnicId   string `json:"vnicId"`
}

type RemoveVMsOperationResponse

type RemoveVMsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudVMCluster
}

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL