sqlvirtualmachinegroups

package
v0.20240320.1143605 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sqlvirtualmachine/2022-02-01/sqlvirtualmachinegroups Documentation

The sqlvirtualmachinegroups SDK allows for interaction with the Azure Resource Manager Service sqlvirtualmachine (API Version 2022-02-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/2022-02-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", "sqlVirtualMachineGroupValue")

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", "sqlVirtualMachineGroupValue")

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", "sqlVirtualMachineGroupValue")

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", "sqlVirtualMachineGroupValue")

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 added in v0.20240215.1143935

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

type ClusterManagerType

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

func (*ClusterManagerType) UnmarshalJSON added in v0.20240215.1143935

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

type ClusterSubnetType

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

func (*ClusterSubnetType) UnmarshalJSON added in v0.20240215.1143935

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 ListByResourceGroupOperationResponse

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

type ListCompleteResult

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

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 added in v0.20240215.1143935

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

type SqlVMGroupImageSku

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

func (*SqlVMGroupImageSku) UnmarshalJSON added in v0.20240215.1143935

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

ID returns the formatted Sql Virtual Machine Group ID

func (SqlVirtualMachineGroupId) Segments

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

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

CreateOrUpdate ...

func (SqlVirtualMachineGroupsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SqlVirtualMachineGroupsClient) Delete

Delete ...

func (SqlVirtualMachineGroupsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (SqlVirtualMachineGroupsClient) Get

Get ...

func (SqlVirtualMachineGroupsClient) List

List ...

func (SqlVirtualMachineGroupsClient) ListByResourceGroup

ListByResourceGroup ...

func (SqlVirtualMachineGroupsClient) ListByResourceGroupComplete

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

ListComplete retrieves all the results into a single object

func (SqlVirtualMachineGroupsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SqlVirtualMachineGroupsClient) Update

Update ...

func (SqlVirtualMachineGroupsClient) UpdateThenPoll

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"`
	OuPath                   *string            `json:"ouPath,omitempty"`
	SqlServiceAccount        *string            `json:"sqlServiceAccount,omitempty"`
	StorageAccountPrimaryKey *string            `json:"storageAccountPrimaryKey,omitempty"`
	StorageAccountUrl        *string            `json:"storageAccountUrl,omitempty"`
}

Jump to

Keyboard shortcuts

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