attacheddatabaseconfigurations

package
v0.20241111.1164443 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2023-08-15/attacheddatabaseconfigurations Documentation

The attacheddatabaseconfigurations SDK allows for interaction with Azure Resource Manager kusto (API Version 2023-08-15).

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/kusto/2023-08-15/attacheddatabaseconfigurations"

Client Initialization

client := attacheddatabaseconfigurations.NewAttachedDatabaseConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AttachedDatabaseConfigurationsClient.CheckNameAvailability

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

payload := attacheddatabaseconfigurations.AttachedDatabaseConfigurationsCheckNameRequest{
	// ...
}


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: AttachedDatabaseConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := attacheddatabaseconfigurations.NewAttachedDatabaseConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "attachedDatabaseConfigurationName")

payload := attacheddatabaseconfigurations.AttachedDatabaseConfiguration{
	// ...
}


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

Example Usage: AttachedDatabaseConfigurationsClient.Delete

ctx := context.TODO()
id := attacheddatabaseconfigurations.NewAttachedDatabaseConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "attachedDatabaseConfigurationName")

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

Example Usage: AttachedDatabaseConfigurationsClient.Get

ctx := context.TODO()
id := attacheddatabaseconfigurations.NewAttachedDatabaseConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "attachedDatabaseConfigurationName")

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: AttachedDatabaseConfigurationsClient.ListByCluster

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAttachedDatabaseType 

func PossibleValuesForAttachedDatabaseType() []string

func PossibleValuesForDefaultPrincipalsModificationKind 

func PossibleValuesForDefaultPrincipalsModificationKind() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReason 

func PossibleValuesForReason() []string

func ValidateAttachedDatabaseConfigurationID 

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

ValidateAttachedDatabaseConfigurationID checks that 'input' can be parsed as a Attached Database Configuration ID

Types

type AttachedDatabaseConfiguration 

type AttachedDatabaseConfiguration struct {
	Id         *string                                  `json:"id,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *AttachedDatabaseConfigurationProperties `json:"properties,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type AttachedDatabaseConfigurationId 

type AttachedDatabaseConfigurationId struct {
	SubscriptionId                    string
	ResourceGroupName                 string
	ClusterName                       string
	AttachedDatabaseConfigurationName string
}

AttachedDatabaseConfigurationId is a struct representing the Resource ID for a Attached Database Configuration

func NewAttachedDatabaseConfigurationID 

func NewAttachedDatabaseConfigurationID(subscriptionId string, resourceGroupName string, clusterName string, attachedDatabaseConfigurationName string) AttachedDatabaseConfigurationId

NewAttachedDatabaseConfigurationID returns a new AttachedDatabaseConfigurationId struct

func ParseAttachedDatabaseConfigurationID 

func ParseAttachedDatabaseConfigurationID(input string) (*AttachedDatabaseConfigurationId, error)

ParseAttachedDatabaseConfigurationID parses 'input' into a AttachedDatabaseConfigurationId

func ParseAttachedDatabaseConfigurationIDInsensitively 

func ParseAttachedDatabaseConfigurationIDInsensitively(input string) (*AttachedDatabaseConfigurationId, error)

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

func (*AttachedDatabaseConfigurationId) FromParseResult 

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

func (AttachedDatabaseConfigurationId) ID 

func (id AttachedDatabaseConfigurationId) ID() string

ID returns the formatted Attached Database Configuration ID

func (AttachedDatabaseConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Attached Database Configuration ID

func (AttachedDatabaseConfigurationId) String 

func (id AttachedDatabaseConfigurationId) String() string

String returns a human-readable description of this Attached Database Configuration ID

type AttachedDatabaseConfigurationListResult 

type AttachedDatabaseConfigurationListResult struct {
	Value *[]AttachedDatabaseConfiguration `json:"value,omitempty"`
}

type AttachedDatabaseConfigurationProperties 

type AttachedDatabaseConfigurationProperties struct {
	AttachedDatabaseNames             *[]string                         `json:"attachedDatabaseNames,omitempty"`
	ClusterResourceId                 string                            `json:"clusterResourceId"`
	DatabaseName                      string                            `json:"databaseName"`
	DatabaseNameOverride              *string                           `json:"databaseNameOverride,omitempty"`
	DatabaseNamePrefix                *string                           `json:"databaseNamePrefix,omitempty"`
	DefaultPrincipalsModificationKind DefaultPrincipalsModificationKind `json:"defaultPrincipalsModificationKind"`
	ProvisioningState                 *ProvisioningState                `json:"provisioningState,omitempty"`
	TableLevelSharingProperties       *TableLevelSharingProperties      `json:"tableLevelSharingProperties,omitempty"`
}

type AttachedDatabaseConfigurationsCheckNameRequest 

type AttachedDatabaseConfigurationsCheckNameRequest struct {
	Name string               `json:"name"`
	Type AttachedDatabaseType `json:"type"`
}

type AttachedDatabaseConfigurationsClient 

type AttachedDatabaseConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewAttachedDatabaseConfigurationsClientWithBaseURI 

func NewAttachedDatabaseConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*AttachedDatabaseConfigurationsClient, error)

func (AttachedDatabaseConfigurationsClient) CheckNameAvailability 

func (c AttachedDatabaseConfigurationsClient) CheckNameAvailability(ctx context.Context, id commonids.KustoClusterId, input AttachedDatabaseConfigurationsCheckNameRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (AttachedDatabaseConfigurationsClient) CreateOrUpdate 

func (c AttachedDatabaseConfigurationsClient) CreateOrUpdate(ctx context.Context, id AttachedDatabaseConfigurationId, input AttachedDatabaseConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AttachedDatabaseConfigurationsClient) CreateOrUpdateThenPoll 

func (c AttachedDatabaseConfigurationsClient) CreateOrUpdateThenPoll(ctx context.Context, id AttachedDatabaseConfigurationId, input AttachedDatabaseConfiguration) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AttachedDatabaseConfigurationsClient) Delete 

func (c AttachedDatabaseConfigurationsClient) Delete(ctx context.Context, id AttachedDatabaseConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (AttachedDatabaseConfigurationsClient) DeleteThenPoll 

func (c AttachedDatabaseConfigurationsClient) DeleteThenPoll(ctx context.Context, id AttachedDatabaseConfigurationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AttachedDatabaseConfigurationsClient) Get 

func (c AttachedDatabaseConfigurationsClient) Get(ctx context.Context, id AttachedDatabaseConfigurationId) (result GetOperationResponse, err error)

Get ...

func (AttachedDatabaseConfigurationsClient) ListByCluster 

func (c AttachedDatabaseConfigurationsClient) ListByCluster(ctx context.Context, id commonids.KustoClusterId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

type AttachedDatabaseType 

type AttachedDatabaseType string
const (
	AttachedDatabaseTypeMicrosoftPointKustoClustersAttachedDatabaseConfigurations AttachedDatabaseType = "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"
)

func (*AttachedDatabaseType) UnmarshalJSON 

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

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	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 CreateOrUpdateOperationResponse 

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

type DefaultPrincipalsModificationKind 

type DefaultPrincipalsModificationKind string
const (
	DefaultPrincipalsModificationKindNone    DefaultPrincipalsModificationKind = "None"
	DefaultPrincipalsModificationKindReplace DefaultPrincipalsModificationKind = "Replace"
	DefaultPrincipalsModificationKindUnion   DefaultPrincipalsModificationKind = "Union"
)

func (*DefaultPrincipalsModificationKind) UnmarshalJSON 

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

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        *AttachedDatabaseConfiguration
}

type ListByClusterOperationResponse 

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AttachedDatabaseConfigurationListResult
}

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

func (*ProvisioningState) UnmarshalJSON 

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

type Reason 

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

func (*Reason) UnmarshalJSON 

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

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"`
}

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.