clusters

package
v0.20231214.1160726 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2023-05-02/clusters Documentation

The clusters SDK allows for interaction with the Azure Resource Manager Service kusto (API Version 2023-05-02).

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/kusto/2023-05-02/clusters"

Client Initialization

client := clusters.NewClustersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClustersClient.AddLanguageExtensions

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

payload := clusters.LanguageExtensionsList{
	// ...
}


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

Example Usage: ClustersClient.CheckNameAvailability

ctx := context.TODO()
id := clusters.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := clusters.ClusterCheckNameRequest{
	// ...
}


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

Example Usage: ClustersClient.CreateOrUpdate

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

payload := clusters.Cluster{
	// ...
}


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

Example Usage: ClustersClient.Delete

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

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

Example Usage: ClustersClient.DetachFollowerDatabases

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

payload := clusters.FollowerDatabaseDefinition{
	// ...
}


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

Example Usage: ClustersClient.DiagnoseVirtualNetwork

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

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

Example Usage: ClustersClient.Get

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

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

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

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

Example Usage: ClustersClient.ListByResourceGroup

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

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

Example Usage: ClustersClient.ListFollowerDatabases

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

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

Example Usage: ClustersClient.ListLanguageExtensions

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

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

Example Usage: ClustersClient.ListSkusByResource

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

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

Example Usage: ClustersClient.Migrate

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

payload := clusters.ClusterMigrateRequest{
	// ...
}


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

Example Usage: ClustersClient.RemoveLanguageExtensions

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

payload := clusters.LanguageExtensionsList{
	// ...
}


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

Example Usage: ClustersClient.Start

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

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

Example Usage: ClustersClient.Stop

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

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

Example Usage: ClustersClient.Update

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

payload := clusters.ClusterUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAzureScaleType 

func PossibleValuesForAzureScaleType() []string

func PossibleValuesForAzureSkuName 

func PossibleValuesForAzureSkuName() []string

func PossibleValuesForAzureSkuTier 

func PossibleValuesForAzureSkuTier() []string

func PossibleValuesForClusterNetworkAccessFlag 

func PossibleValuesForClusterNetworkAccessFlag() []string

func PossibleValuesForClusterType 

func PossibleValuesForClusterType() []string

func PossibleValuesForDatabaseShareOrigin 

func PossibleValuesForDatabaseShareOrigin() []string

func PossibleValuesForEngineType 

func PossibleValuesForEngineType() []string

func PossibleValuesForLanguageExtensionImageName 

func PossibleValuesForLanguageExtensionImageName() []string

func PossibleValuesForLanguageExtensionName 

func PossibleValuesForLanguageExtensionName() []string

func PossibleValuesForMigrationClusterRole 

func PossibleValuesForMigrationClusterRole() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicIPType 

func PossibleValuesForPublicIPType() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForReason 

func PossibleValuesForReason() []string

func PossibleValuesForState 

func PossibleValuesForState() []string

func ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AcceptedAudiences 

type AcceptedAudiences struct {
	Value *string `json:"value,omitempty"`
}

type AddLanguageExtensionsOperationResponse 

type AddLanguageExtensionsOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type AzureCapacity 

type AzureCapacity struct {
	Default   int64          `json:"default"`
	Maximum   int64          `json:"maximum"`
	Minimum   int64          `json:"minimum"`
	ScaleType AzureScaleType `json:"scaleType"`
}

type AzureResourceSku 

type AzureResourceSku struct {
	Capacity     *AzureCapacity `json:"capacity,omitempty"`
	ResourceType *string        `json:"resourceType,omitempty"`
	Sku          *AzureSku      `json:"sku,omitempty"`
}

type AzureScaleType 

type AzureScaleType string
const (
	AzureScaleTypeAutomatic AzureScaleType = "automatic"
	AzureScaleTypeManual    AzureScaleType = "manual"
	AzureScaleTypeNone      AzureScaleType = "none"
)

type AzureSku 

type AzureSku struct {
	Capacity *int64       `json:"capacity,omitempty"`
	Name     AzureSkuName `json:"name"`
	Tier     AzureSkuTier `json:"tier"`
}

type AzureSkuName 

type AzureSkuName string
const (
	AzureSkuNameDevNoSLAStandardDOneOneVTwo              AzureSkuName = "Dev(No SLA)_Standard_D11_v2"
	AzureSkuNameDevNoSLAStandardETwoaVFour               AzureSkuName = "Dev(No SLA)_Standard_E2a_v4"
	AzureSkuNameStandardDOneFourVTwo                     AzureSkuName = "Standard_D14_v2"
	AzureSkuNameStandardDOneOneVTwo                      AzureSkuName = "Standard_D11_v2"
	AzureSkuNameStandardDOneSixdVFive                    AzureSkuName = "Standard_D16d_v5"
	AzureSkuNameStandardDOneThreeVTwo                    AzureSkuName = "Standard_D13_v2"
	AzureSkuNameStandardDOneTwoVTwo                      AzureSkuName = "Standard_D12_v2"
	AzureSkuNameStandardDSOneFourVTwoPositiveFourTBPS    AzureSkuName = "Standard_DS14_v2+4TB_PS"
	AzureSkuNameStandardDSOneFourVTwoPositiveThreeTBPS   AzureSkuName = "Standard_DS14_v2+3TB_PS"
	AzureSkuNameStandardDSOneThreeVTwoPositiveOneTBPS    AzureSkuName = "Standard_DS13_v2+1TB_PS"
	AzureSkuNameStandardDSOneThreeVTwoPositiveTwoTBPS    AzureSkuName = "Standard_DS13_v2+2TB_PS"
	AzureSkuNameStandardDThreeTwodVFive                  AzureSkuName = "Standard_D32d_v5"
	AzureSkuNameStandardDThreeTwodVFour                  AzureSkuName = "Standard_D32d_v4"
	AzureSkuNameStandardECEightadsVFive                  AzureSkuName = "Standard_EC8ads_v5"
	AzureSkuNameStandardECEightasVFivePositiveOneTBPS    AzureSkuName = "Standard_EC8as_v5+1TB_PS"
	AzureSkuNameStandardECEightasVFivePositiveTwoTBPS    AzureSkuName = "Standard_EC8as_v5+2TB_PS"
	AzureSkuNameStandardECOneSixadsVFive                 AzureSkuName = "Standard_EC16ads_v5"
	AzureSkuNameStandardECOneSixasVFivePositiveFourTBPS  AzureSkuName = "Standard_EC16as_v5+4TB_PS"
	AzureSkuNameStandardECOneSixasVFivePositiveThreeTBPS AzureSkuName = "Standard_EC16as_v5+3TB_PS"
	AzureSkuNameStandardEEightZeroidsVFour               AzureSkuName = "Standard_E80ids_v4"
	AzureSkuNameStandardEEightaVFour                     AzureSkuName = "Standard_E8a_v4"
	AzureSkuNameStandardEEightadsVFive                   AzureSkuName = "Standard_E8ads_v5"
	AzureSkuNameStandardEEightasVFivePositiveOneTBPS     AzureSkuName = "Standard_E8as_v5+1TB_PS"
	AzureSkuNameStandardEEightasVFivePositiveTwoTBPS     AzureSkuName = "Standard_E8as_v5+2TB_PS"
	AzureSkuNameStandardEEightasVFourPositiveOneTBPS     AzureSkuName = "Standard_E8as_v4+1TB_PS"
	AzureSkuNameStandardEEightasVFourPositiveTwoTBPS     AzureSkuName = "Standard_E8as_v4+2TB_PS"
	AzureSkuNameStandardEEightdVFive                     AzureSkuName = "Standard_E8d_v5"
	AzureSkuNameStandardEEightdVFour                     AzureSkuName = "Standard_E8d_v4"
	AzureSkuNameStandardEEightsVFivePositiveOneTBPS      AzureSkuName = "Standard_E8s_v5+1TB_PS"
	AzureSkuNameStandardEEightsVFivePositiveTwoTBPS      AzureSkuName = "Standard_E8s_v5+2TB_PS"
	AzureSkuNameStandardEEightsVFourPositiveOneTBPS      AzureSkuName = "Standard_E8s_v4+1TB_PS"
	AzureSkuNameStandardEEightsVFourPositiveTwoTBPS      AzureSkuName = "Standard_E8s_v4+2TB_PS"
	AzureSkuNameStandardEFouraVFour                      AzureSkuName = "Standard_E4a_v4"
	AzureSkuNameStandardEFouradsVFive                    AzureSkuName = "Standard_E4ads_v5"
	AzureSkuNameStandardEFourdVFive                      AzureSkuName = "Standard_E4d_v5"
	AzureSkuNameStandardEFourdVFour                      AzureSkuName = "Standard_E4d_v4"
	AzureSkuNameStandardEOneSixaVFour                    AzureSkuName = "Standard_E16a_v4"
	AzureSkuNameStandardEOneSixadsVFive                  AzureSkuName = "Standard_E16ads_v5"
	AzureSkuNameStandardEOneSixasVFivePositiveFourTBPS   AzureSkuName = "Standard_E16as_v5+4TB_PS"
	AzureSkuNameStandardEOneSixasVFivePositiveThreeTBPS  AzureSkuName = "Standard_E16as_v5+3TB_PS"
	AzureSkuNameStandardEOneSixasVFourPositiveFourTBPS   AzureSkuName = "Standard_E16as_v4+4TB_PS"
	AzureSkuNameStandardEOneSixasVFourPositiveThreeTBPS  AzureSkuName = "Standard_E16as_v4+3TB_PS"
	AzureSkuNameStandardEOneSixdVFive                    AzureSkuName = "Standard_E16d_v5"
	AzureSkuNameStandardEOneSixdVFour                    AzureSkuName = "Standard_E16d_v4"
	AzureSkuNameStandardEOneSixsVFivePositiveFourTBPS    AzureSkuName = "Standard_E16s_v5+4TB_PS"
	AzureSkuNameStandardEOneSixsVFivePositiveThreeTBPS   AzureSkuName = "Standard_E16s_v5+3TB_PS"
	AzureSkuNameStandardEOneSixsVFourPositiveFourTBPS    AzureSkuName = "Standard_E16s_v4+4TB_PS"
	AzureSkuNameStandardEOneSixsVFourPositiveThreeTBPS   AzureSkuName = "Standard_E16s_v4+3TB_PS"
	AzureSkuNameStandardESixFouriVThree                  AzureSkuName = "Standard_E64i_v3"
	AzureSkuNameStandardETwoaVFour                       AzureSkuName = "Standard_E2a_v4"
	AzureSkuNameStandardETwoadsVFive                     AzureSkuName = "Standard_E2ads_v5"
	AzureSkuNameStandardETwodVFive                       AzureSkuName = "Standard_E2d_v5"
	AzureSkuNameStandardETwodVFour                       AzureSkuName = "Standard_E2d_v4"
	AzureSkuNameStandardLEightasVThree                   AzureSkuName = "Standard_L8as_v3"
	AzureSkuNameStandardLEights                          AzureSkuName = "Standard_L8s"
	AzureSkuNameStandardLEightsVThree                    AzureSkuName = "Standard_L8s_v3"
	AzureSkuNameStandardLEightsVTwo                      AzureSkuName = "Standard_L8s_v2"
	AzureSkuNameStandardLFours                           AzureSkuName = "Standard_L4s"
	AzureSkuNameStandardLOneSixasVThree                  AzureSkuName = "Standard_L16as_v3"
	AzureSkuNameStandardLOneSixs                         AzureSkuName = "Standard_L16s"
	AzureSkuNameStandardLOneSixsVThree                   AzureSkuName = "Standard_L16s_v3"
	AzureSkuNameStandardLOneSixsVTwo                     AzureSkuName = "Standard_L16s_v2"
	AzureSkuNameStandardLThreeTwoasVThree                AzureSkuName = "Standard_L32as_v3"
	AzureSkuNameStandardLThreeTwosVThree                 AzureSkuName = "Standard_L32s_v3"
)

type AzureSkuTier 

type AzureSkuTier string
const (
	AzureSkuTierBasic    AzureSkuTier = "Basic"
	AzureSkuTierStandard AzureSkuTier = "Standard"
)

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameResult
}

type CheckNameResult 

type CheckNameResult struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type Cluster 

type Cluster struct {
	Etag       *string                            `json:"etag,omitempty"`
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ClusterProperties                 `json:"properties,omitempty"`
	Sku        AzureSku                           `json:"sku"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
	Zones      *zones.Schema                      `json:"zones,omitempty"`
}

type ClusterCheckNameRequest 

type ClusterCheckNameRequest struct {
	Name string      `json:"name"`
	Type ClusterType `json:"type"`
}

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult added in v0.20231127.1171502 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type ClusterListResult 

type ClusterListResult struct {
	Value *[]Cluster `json:"value,omitempty"`
}

type ClusterMigrateRequest 

type ClusterMigrateRequest struct {
	ClusterResourceId string `json:"clusterResourceId"`
}

type ClusterNetworkAccessFlag 

type ClusterNetworkAccessFlag string
const (
	ClusterNetworkAccessFlagDisabled ClusterNetworkAccessFlag = "Disabled"
	ClusterNetworkAccessFlagEnabled  ClusterNetworkAccessFlag = "Enabled"
)

type ClusterProperties 

type ClusterProperties struct {
	AcceptedAudiences                  *[]AcceptedAudiences         `json:"acceptedAudiences,omitempty"`
	AllowedFqdnList                    *[]string                    `json:"allowedFqdnList,omitempty"`
	AllowedIPRangeList                 *[]string                    `json:"allowedIpRangeList,omitempty"`
	DataIngestionUri                   *string                      `json:"dataIngestionUri,omitempty"`
	EnableAutoStop                     *bool                        `json:"enableAutoStop,omitempty"`
	EnableDiskEncryption               *bool                        `json:"enableDiskEncryption,omitempty"`
	EnableDoubleEncryption             *bool                        `json:"enableDoubleEncryption,omitempty"`
	EnablePurge                        *bool                        `json:"enablePurge,omitempty"`
	EnableStreamingIngest              *bool                        `json:"enableStreamingIngest,omitempty"`
	EngineType                         *EngineType                  `json:"engineType,omitempty"`
	KeyVaultProperties                 *KeyVaultProperties          `json:"keyVaultProperties,omitempty"`
	LanguageExtensions                 *LanguageExtensionsList      `json:"languageExtensions,omitempty"`
	MigrationCluster                   *MigrationClusterProperties  `json:"migrationCluster,omitempty"`
	OptimizedAutoscale                 *OptimizedAutoscale          `json:"optimizedAutoscale,omitempty"`
	PrivateEndpointConnections         *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                  *ProvisioningState           `json:"provisioningState,omitempty"`
	PublicIPType                       *PublicIPType                `json:"publicIPType,omitempty"`
	PublicNetworkAccess                *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
	RestrictOutboundNetworkAccess      *ClusterNetworkAccessFlag    `json:"restrictOutboundNetworkAccess,omitempty"`
	State                              *State                       `json:"state,omitempty"`
	StateReason                        *string                      `json:"stateReason,omitempty"`
	TrustedExternalTenants             *[]TrustedExternalTenant     `json:"trustedExternalTenants,omitempty"`
	Uri                                *string                      `json:"uri,omitempty"`
	VirtualClusterGraduationProperties *string                      `json:"virtualClusterGraduationProperties,omitempty"`
	VirtualNetworkConfiguration        *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
}

type ClusterType 

type ClusterType string
const (
	ClusterTypeMicrosoftPointKustoClusters ClusterType = "Microsoft.Kusto/clusters"
)

type ClusterUpdate 

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

type ClustersClient 

type ClustersClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewClustersClientWithBaseURI 

func NewClustersClientWithBaseURI(endpoint string) ClustersClient

func (ClustersClient) AddLanguageExtensions 

func (c ClustersClient) AddLanguageExtensions(ctx context.Context, id ClusterId, input LanguageExtensionsList) (result AddLanguageExtensionsOperationResponse, err error)

AddLanguageExtensions ...

func (ClustersClient) AddLanguageExtensionsThenPoll 

func (c ClustersClient) AddLanguageExtensionsThenPoll(ctx context.Context, id ClusterId, input LanguageExtensionsList) error

AddLanguageExtensionsThenPoll performs AddLanguageExtensions then polls until it's completed

func (ClustersClient) CheckNameAvailability 

func (c ClustersClient) CheckNameAvailability(ctx context.Context, id LocationId, input ClusterCheckNameRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ClustersClient) CreateOrUpdate 

func (c ClustersClient) CreateOrUpdate(ctx context.Context, id ClusterId, input Cluster, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ClustersClient) CreateOrUpdateThenPoll 

func (c ClustersClient) CreateOrUpdateThenPoll(ctx context.Context, id ClusterId, input Cluster, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClustersClient) Delete 

func (c ClustersClient) Delete(ctx context.Context, id ClusterId) (result DeleteOperationResponse, err error)

Delete ...

func (ClustersClient) DeleteThenPoll 

func (c ClustersClient) DeleteThenPoll(ctx context.Context, id ClusterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ClustersClient) DetachFollowerDatabases 

func (c ClustersClient) DetachFollowerDatabases(ctx context.Context, id ClusterId, input FollowerDatabaseDefinition) (result DetachFollowerDatabasesOperationResponse, err error)

DetachFollowerDatabases ...

func (ClustersClient) DetachFollowerDatabasesThenPoll 

func (c ClustersClient) DetachFollowerDatabasesThenPoll(ctx context.Context, id ClusterId, input FollowerDatabaseDefinition) error

DetachFollowerDatabasesThenPoll performs DetachFollowerDatabases then polls until it's completed

func (ClustersClient) DiagnoseVirtualNetwork 

func (c ClustersClient) DiagnoseVirtualNetwork(ctx context.Context, id ClusterId) (result DiagnoseVirtualNetworkOperationResponse, err error)

DiagnoseVirtualNetwork ...

func (ClustersClient) DiagnoseVirtualNetworkThenPoll 

func (c ClustersClient) DiagnoseVirtualNetworkThenPoll(ctx context.Context, id ClusterId) error

DiagnoseVirtualNetworkThenPoll performs DiagnoseVirtualNetwork then polls until it's completed

func (ClustersClient) Get 

func (c ClustersClient) Get(ctx context.Context, id ClusterId) (result GetOperationResponse, err error)

Get ...

func (ClustersClient) List 

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

List ...

func (ClustersClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (ClustersClient) ListFollowerDatabases 

func (c ClustersClient) ListFollowerDatabases(ctx context.Context, id ClusterId) (result ListFollowerDatabasesOperationResponse, err error)

ListFollowerDatabases ...

func (ClustersClient) ListLanguageExtensions 

func (c ClustersClient) ListLanguageExtensions(ctx context.Context, id ClusterId) (result ListLanguageExtensionsOperationResponse, err error)

ListLanguageExtensions ...

func (ClustersClient) ListSkusByResource 

func (c ClustersClient) ListSkusByResource(ctx context.Context, id ClusterId) (result ListSkusByResourceOperationResponse, err error)

ListSkusByResource ...

func (ClustersClient) Migrate 

func (c ClustersClient) Migrate(ctx context.Context, id ClusterId, input ClusterMigrateRequest) (result MigrateOperationResponse, err error)

Migrate ...

func (ClustersClient) MigrateThenPoll 

func (c ClustersClient) MigrateThenPoll(ctx context.Context, id ClusterId, input ClusterMigrateRequest) error

MigrateThenPoll performs Migrate then polls until it's completed

func (ClustersClient) RemoveLanguageExtensions 

func (c ClustersClient) RemoveLanguageExtensions(ctx context.Context, id ClusterId, input LanguageExtensionsList) (result RemoveLanguageExtensionsOperationResponse, err error)

RemoveLanguageExtensions ...

func (ClustersClient) RemoveLanguageExtensionsThenPoll 

func (c ClustersClient) RemoveLanguageExtensionsThenPoll(ctx context.Context, id ClusterId, input LanguageExtensionsList) error

RemoveLanguageExtensionsThenPoll performs RemoveLanguageExtensions then polls until it's completed

func (ClustersClient) Start 

func (c ClustersClient) Start(ctx context.Context, id ClusterId) (result StartOperationResponse, err error)

Start ...

func (ClustersClient) StartThenPoll 

func (c ClustersClient) StartThenPoll(ctx context.Context, id ClusterId) error

StartThenPoll performs Start then polls until it's completed

func (ClustersClient) Stop 

func (c ClustersClient) Stop(ctx context.Context, id ClusterId) (result StopOperationResponse, err error)

Stop ...

func (ClustersClient) StopThenPoll 

func (c ClustersClient) StopThenPoll(ctx context.Context, id ClusterId) error

StopThenPoll performs Stop then polls until it's completed

func (ClustersClient) Update 

func (c ClustersClient) Update(ctx context.Context, id ClusterId, input ClusterUpdate, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

func (ClustersClient) UpdateThenPoll 

func (c ClustersClient) UpdateThenPoll(ctx context.Context, id ClusterId, input ClusterUpdate, options UpdateOperationOptions) error

UpdateThenPoll performs Update then polls until it's completed

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DatabaseShareOrigin 

type DatabaseShareOrigin string
const (
	DatabaseShareOriginDataShare DatabaseShareOrigin = "DataShare"
	DatabaseShareOriginDirect    DatabaseShareOrigin = "Direct"
	DatabaseShareOriginOther     DatabaseShareOrigin = "Other"
)

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DetachFollowerDatabasesOperationResponse 

type DetachFollowerDatabasesOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DiagnoseVirtualNetworkOperationResponse 

type DiagnoseVirtualNetworkOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DiagnoseVirtualNetworkResult 

type DiagnoseVirtualNetworkResult struct {
	Findings *[]string `json:"findings,omitempty"`
}

type EngineType 

type EngineType string
const (
	EngineTypeVThree EngineType = "V3"
	EngineTypeVTwo   EngineType = "V2"
)

type FollowerDatabaseDefinition 

type FollowerDatabaseDefinition struct {
	AttachedDatabaseConfigurationName string                       `json:"attachedDatabaseConfigurationName"`
	ClusterResourceId                 string                       `json:"clusterResourceId"`
	DatabaseName                      *string                      `json:"databaseName,omitempty"`
	DatabaseShareOrigin               *DatabaseShareOrigin         `json:"databaseShareOrigin,omitempty"`
	TableLevelSharingProperties       *TableLevelSharingProperties `json:"tableLevelSharingProperties,omitempty"`
}

type FollowerDatabaseListResult 

type FollowerDatabaseListResult struct {
	Value *[]FollowerDatabaseDefinition `json:"value,omitempty"`
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Cluster
}

type KeyVaultProperties 

type KeyVaultProperties struct {
	KeyName      *string `json:"keyName,omitempty"`
	KeyVaultUri  *string `json:"keyVaultUri,omitempty"`
	KeyVersion   *string `json:"keyVersion,omitempty"`
	UserIdentity *string `json:"userIdentity,omitempty"`
}

type LanguageExtension 

type LanguageExtension struct {
	LanguageExtensionImageName *LanguageExtensionImageName `json:"languageExtensionImageName,omitempty"`
	LanguageExtensionName      *LanguageExtensionName      `json:"languageExtensionName,omitempty"`
}

type LanguageExtensionImageName 

type LanguageExtensionImageName string
const (
	LanguageExtensionImageNamePythonThreeOneZeroEight LanguageExtensionImageName = "Python3_10_8"
	LanguageExtensionImageNamePythonThreeSixFive      LanguageExtensionImageName = "Python3_6_5"
	LanguageExtensionImageNameR                       LanguageExtensionImageName = "R"
)

type LanguageExtensionName 

type LanguageExtensionName string
const (
	LanguageExtensionNamePYTHON LanguageExtensionName = "PYTHON"
	LanguageExtensionNameR      LanguageExtensionName = "R"
)

type LanguageExtensionsList 

type LanguageExtensionsList struct {
	Value *[]LanguageExtension `json:"value,omitempty"`
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *ClusterListResult
}

type ListFollowerDatabasesOperationResponse 

type ListFollowerDatabasesOperationResponse struct {
	HttpResponse *http.Response
	Model        *FollowerDatabaseListResult
}

type ListLanguageExtensionsOperationResponse 

type ListLanguageExtensionsOperationResponse struct {
	HttpResponse *http.Response
	Model        *LanguageExtensionsList
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *ClusterListResult
}

type ListResourceSkusResult 

type ListResourceSkusResult struct {
	Value *[]AzureResourceSku `json:"value,omitempty"`
}

type ListSkusByResourceOperationResponse 

type ListSkusByResourceOperationResponse struct {
	HttpResponse *http.Response
	Model        *ListResourceSkusResult
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult added in v0.20231127.1171502 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type MigrateOperationResponse 

type MigrateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type MigrationClusterProperties 

type MigrationClusterProperties struct {
	DataIngestionUri *string               `json:"dataIngestionUri,omitempty"`
	Id               *string               `json:"id,omitempty"`
	Role             *MigrationClusterRole `json:"role,omitempty"`
	Uri              *string               `json:"uri,omitempty"`
}

type MigrationClusterRole 

type MigrationClusterRole string
const (
	MigrationClusterRoleDestination MigrationClusterRole = "Destination"
	MigrationClusterRoleSource      MigrationClusterRole = "Source"
)

type OptimizedAutoscale 

type OptimizedAutoscale struct {
	IsEnabled bool  `json:"isEnabled"`
	Maximum   int64 `json:"maximum"`
	Minimum   int64 `json:"minimum"`
	Version   int64 `json:"version"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupId                           *string                                   `json:"groupId,omitempty"`
	PrivateEndpoint                   *PrivateEndpointProperty                  `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *string                                   `json:"provisioningState,omitempty"`
}

type PrivateEndpointProperty 

type PrivateEndpointProperty struct {
	Id *string `json:"id,omitempty"`
}

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	ActionsRequired *string `json:"actionsRequired,omitempty"`
	Description     *string `json:"description,omitempty"`
	Status          *string `json:"status,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

type PublicIPType 

type PublicIPType string
const (
	PublicIPTypeDualStack PublicIPType = "DualStack"
	PublicIPTypeIPvFour   PublicIPType = "IPv4"
)

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

type Reason 

type Reason string
const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

type RemoveLanguageExtensionsOperationResponse 

type RemoveLanguageExtensionsOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type StartOperationResponse 

type StartOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type State 

type State string
const (
	StateCreating    State = "Creating"
	StateDeleted     State = "Deleted"
	StateDeleting    State = "Deleting"
	StateMigrated    State = "Migrated"
	StateRunning     State = "Running"
	StateStarting    State = "Starting"
	StateStopped     State = "Stopped"
	StateStopping    State = "Stopping"
	StateUnavailable State = "Unavailable"
	StateUpdating    State = "Updating"
)

type StopOperationResponse 

type StopOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type TableLevelSharingProperties 

type TableLevelSharingProperties struct {
	ExternalTablesToExclude    *[]string `json:"externalTablesToExclude,omitempty"`
	ExternalTablesToInclude    *[]string `json:"externalTablesToInclude,omitempty"`
	FunctionsToExclude         *[]string `json:"functionsToExclude,omitempty"`
	FunctionsToInclude         *[]string `json:"functionsToInclude,omitempty"`
	MaterializedViewsToExclude *[]string `json:"materializedViewsToExclude,omitempty"`
	MaterializedViewsToInclude *[]string `json:"materializedViewsToInclude,omitempty"`
	TablesToExclude            *[]string `json:"tablesToExclude,omitempty"`
	TablesToInclude            *[]string `json:"tablesToInclude,omitempty"`
}

type TrustedExternalTenant 

type TrustedExternalTenant struct {
	Value *string `json:"value,omitempty"`
}

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type VirtualNetworkConfiguration 

type VirtualNetworkConfiguration struct {
	DataManagementPublicIPId string `json:"dataManagementPublicIpId"`
	EnginePublicIPId         string `json:"enginePublicIpId"`
	SubnetId                 string `json:"subnetId"`
}

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.