sqlvirtualmachinegroups

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sqlvirtualmachine/2023-10-01/sqlvirtualmachinegroups Documentation

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

Client Initialization

client := sqlvirtualmachinegroups.NewSqlVirtualMachineGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlVirtualMachineGroupsClient.CreateOrUpdate

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

payload := sqlvirtualmachinegroups.SqlVirtualMachineGroup{
	// ...
}


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

Example Usage: SqlVirtualMachineGroupsClient.Delete

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

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

Example Usage: SqlVirtualMachineGroupsClient.Get

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

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

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

// 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: SqlVirtualMachineGroupsClient.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: SqlVirtualMachineGroupsClient.Update

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

payload := sqlvirtualmachinegroups.SqlVirtualMachineGroupUpdate{
	// ...
}


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 PossibleValuesForClusterConfiguration 

func PossibleValuesForClusterConfiguration() []string

func PossibleValuesForClusterManagerType 

func PossibleValuesForClusterManagerType() []string

func PossibleValuesForClusterSubnetType 

func PossibleValuesForClusterSubnetType() []string

func PossibleValuesForScaleType 

func PossibleValuesForScaleType() []string

func PossibleValuesForSqlVMGroupImageSku 

func PossibleValuesForSqlVMGroupImageSku() []string

func ValidateSqlVirtualMachineGroupID 

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

ValidateSqlVirtualMachineGroupID checks that 'input' can be parsed as a Sql Virtual Machine Group ID

Types

type ClusterConfiguration 

type ClusterConfiguration string
const (
	ClusterConfigurationDomainful ClusterConfiguration = "Domainful"
)

func (*ClusterConfiguration) UnmarshalJSON 

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

type ClusterManagerType 

type ClusterManagerType string
const (
	ClusterManagerTypeWSFC ClusterManagerType = "WSFC"
)

func (*ClusterManagerType) UnmarshalJSON 

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

type ClusterSubnetType 

type ClusterSubnetType string
const (
	ClusterSubnetTypeMultiSubnet  ClusterSubnetType = "MultiSubnet"
	ClusterSubnetTypeSingleSubnet ClusterSubnetType = "SingleSubnet"
)

func (*ClusterSubnetType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

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        *[]SqlVirtualMachineGroup
}

type ListCompleteResult 

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

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        *[]SqlVirtualMachineGroup
}

type ScaleType 

type ScaleType string
const (
	ScaleTypeHA ScaleType = "HA"
)

func (*ScaleType) UnmarshalJSON 

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

type SqlVMGroupImageSku 

type SqlVMGroupImageSku string
const (
	SqlVMGroupImageSkuDeveloper  SqlVMGroupImageSku = "Developer"
	SqlVMGroupImageSkuEnterprise SqlVMGroupImageSku = "Enterprise"
)

func (*SqlVMGroupImageSku) UnmarshalJSON 

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

type SqlVirtualMachineGroup 

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

type SqlVirtualMachineGroupId 

type SqlVirtualMachineGroupId struct {
	SubscriptionId             string
	ResourceGroupName          string
	SqlVirtualMachineGroupName string
}

SqlVirtualMachineGroupId is a struct representing the Resource ID for a Sql Virtual Machine Group

func NewSqlVirtualMachineGroupID 

func NewSqlVirtualMachineGroupID(subscriptionId string, resourceGroupName string, sqlVirtualMachineGroupName string) SqlVirtualMachineGroupId

NewSqlVirtualMachineGroupID returns a new SqlVirtualMachineGroupId struct

func ParseSqlVirtualMachineGroupID 

func ParseSqlVirtualMachineGroupID(input string) (*SqlVirtualMachineGroupId, error)

ParseSqlVirtualMachineGroupID parses 'input' into a SqlVirtualMachineGroupId

func ParseSqlVirtualMachineGroupIDInsensitively 

func ParseSqlVirtualMachineGroupIDInsensitively(input string) (*SqlVirtualMachineGroupId, error)

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

func (*SqlVirtualMachineGroupId) FromParseResult 

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

func (SqlVirtualMachineGroupId) ID 

func (id SqlVirtualMachineGroupId) ID() string

ID returns the formatted Sql Virtual Machine Group ID

func (SqlVirtualMachineGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sql Virtual Machine Group ID

func (SqlVirtualMachineGroupId) String 

func (id SqlVirtualMachineGroupId) String() string

String returns a human-readable description of this Sql Virtual Machine Group ID

type SqlVirtualMachineGroupOperationPredicate 

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

func (SqlVirtualMachineGroupOperationPredicate) Matches 

func (p SqlVirtualMachineGroupOperationPredicate) Matches(input SqlVirtualMachineGroup) bool

type SqlVirtualMachineGroupProperties 

type SqlVirtualMachineGroupProperties struct {
	ClusterConfiguration *ClusterConfiguration `json:"clusterConfiguration,omitempty"`
	ClusterManagerType   *ClusterManagerType   `json:"clusterManagerType,omitempty"`
	ProvisioningState    *string               `json:"provisioningState,omitempty"`
	ScaleType            *ScaleType            `json:"scaleType,omitempty"`
	SqlImageOffer        *string               `json:"sqlImageOffer,omitempty"`
	SqlImageSku          *SqlVMGroupImageSku   `json:"sqlImageSku,omitempty"`
	WsfcDomainProfile    *WsfcDomainProfile    `json:"wsfcDomainProfile,omitempty"`
}

type SqlVirtualMachineGroupUpdate 

type SqlVirtualMachineGroupUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type SqlVirtualMachineGroupsClient 

type SqlVirtualMachineGroupsClient struct {
	Client *resourcemanager.Client
}

func NewSqlVirtualMachineGroupsClientWithBaseURI 

func NewSqlVirtualMachineGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlVirtualMachineGroupsClient, error)

func (SqlVirtualMachineGroupsClient) CreateOrUpdate 

func (c SqlVirtualMachineGroupsClient) CreateOrUpdate(ctx context.Context, id SqlVirtualMachineGroupId, input SqlVirtualMachineGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SqlVirtualMachineGroupsClient) CreateOrUpdateThenPoll 

func (c SqlVirtualMachineGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id SqlVirtualMachineGroupId, input SqlVirtualMachineGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SqlVirtualMachineGroupsClient) Delete 

func (c SqlVirtualMachineGroupsClient) Delete(ctx context.Context, id SqlVirtualMachineGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (SqlVirtualMachineGroupsClient) DeleteThenPoll 

func (c SqlVirtualMachineGroupsClient) DeleteThenPoll(ctx context.Context, id SqlVirtualMachineGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SqlVirtualMachineGroupsClient) Get 

func (c SqlVirtualMachineGroupsClient) Get(ctx context.Context, id SqlVirtualMachineGroupId) (result GetOperationResponse, err error)

Get ...

func (SqlVirtualMachineGroupsClient) List 

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

List ...

func (SqlVirtualMachineGroupsClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (SqlVirtualMachineGroupsClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (SqlVirtualMachineGroupsClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SqlVirtualMachineGroupsClient) ListComplete 

func (c SqlVirtualMachineGroupsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SqlVirtualMachineGroupsClient) ListCompleteMatchingPredicate 

func (c SqlVirtualMachineGroupsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SqlVirtualMachineGroupOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SqlVirtualMachineGroupsClient) Update 

func (c SqlVirtualMachineGroupsClient) Update(ctx context.Context, id SqlVirtualMachineGroupId, input SqlVirtualMachineGroupUpdate) (result UpdateOperationResponse, err error)

Update ...

func (SqlVirtualMachineGroupsClient) UpdateThenPoll 

func (c SqlVirtualMachineGroupsClient) UpdateThenPoll(ctx context.Context, id SqlVirtualMachineGroupId, input SqlVirtualMachineGroupUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type UpdateOperationResponse 

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

type WsfcDomainProfile 

type WsfcDomainProfile struct {
	ClusterBootstrapAccount  *string            `json:"clusterBootstrapAccount,omitempty"`
	ClusterOperatorAccount   *string            `json:"clusterOperatorAccount,omitempty"`
	ClusterSubnetType        *ClusterSubnetType `json:"clusterSubnetType,omitempty"`
	DomainFqdn               *string            `json:"domainFqdn,omitempty"`
	FileShareWitnessPath     *string            `json:"fileShareWitnessPath,omitempty"`
	IsSqlServiceAccountGmsa  *bool              `json:"isSqlServiceAccountGmsa,omitempty"`
	OuPath                   *string            `json:"ouPath,omitempty"`
	SqlServiceAccount        *string            `json:"sqlServiceAccount,omitempty"`
	StorageAccountPrimaryKey *string            `json:"storageAccountPrimaryKey,omitempty"`
	StorageAccountUrl        *string            `json:"storageAccountUrl,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.