databases

package
v0.20240611.1085123 Latest Latest
Warning

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

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

README

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

The databases SDK allows for interaction with the Azure Resource Manager Service 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/databases"

Client Initialization

client := databases.NewDatabasesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabasesClient.AddPrincipals

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

payload := databases.DatabasePrincipalListRequest{
	// ...
}


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

Example Usage: DatabasesClient.CheckNameAvailability

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

payload := databases.CheckNameRequest{
	// ...
}


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

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

payload := databases.Database{
	// ...
}


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

Example Usage: DatabasesClient.DatabaseInviteFollower

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

payload := databases.DatabaseInviteFollowerRequest{
	// ...
}


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

Example Usage: DatabasesClient.Delete

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

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

Example Usage: DatabasesClient.Get

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

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

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

// alternatively `client.ListByCluster(ctx, id, databases.DefaultListByClusterOperationOptions())` can be used to do batched pagination
items, err := client.ListByClusterComplete(ctx, id, databases.DefaultListByClusterOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DatabasesClient.ListPrincipals

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

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

Example Usage: DatabasesClient.RemovePrincipals

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

payload := databases.DatabasePrincipalListRequest{
	// ...
}


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

Example Usage: DatabasesClient.Update

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

payload := databases.Database{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCallerRole

func PossibleValuesForCallerRole() []string

func PossibleValuesForDatabasePrincipalRole

func PossibleValuesForDatabasePrincipalRole() []string

func PossibleValuesForDatabasePrincipalType

func PossibleValuesForDatabasePrincipalType() []string

func PossibleValuesForDatabaseShareOrigin

func PossibleValuesForDatabaseShareOrigin() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func PossibleValuesForPrincipalsModificationKind

func PossibleValuesForPrincipalsModificationKind() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReason

func PossibleValuesForReason() []string

func PossibleValuesForType

func PossibleValuesForType() []string

Types

type AddPrincipalsOperationResponse

type AddPrincipalsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabasePrincipalListResult
}

type CallerRole

type CallerRole string
const (
	CallerRoleAdmin CallerRole = "Admin"
	CallerRoleNone  CallerRole = "None"
)

func (*CallerRole) UnmarshalJSON

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

type CheckNameAvailabilityOperationResponse

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

type CheckNameRequest

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

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 CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	CallerRole *CallerRole
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders

func (CreateOrUpdateOperationOptions) ToOData

func (CreateOrUpdateOperationOptions) ToQuery

type CreateOrUpdateOperationResponse

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

type Database

type Database interface {
}

type DatabaseInviteFollowerOperationResponse

type DatabaseInviteFollowerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabaseInviteFollowerResult
}

type DatabaseInviteFollowerRequest

type DatabaseInviteFollowerRequest struct {
	InviteeEmail                string                       `json:"inviteeEmail"`
	TableLevelSharingProperties *TableLevelSharingProperties `json:"tableLevelSharingProperties,omitempty"`
}

type DatabaseInviteFollowerResult

type DatabaseInviteFollowerResult struct {
	GeneratedInvitation *string `json:"generatedInvitation,omitempty"`
}

type DatabaseOperationPredicate

type DatabaseOperationPredicate struct {
}

func (DatabaseOperationPredicate) Matches

func (p DatabaseOperationPredicate) Matches(input Database) bool

type DatabasePrincipal

type DatabasePrincipal struct {
	AppId      *string               `json:"appId,omitempty"`
	Email      *string               `json:"email,omitempty"`
	Fqn        *string               `json:"fqn,omitempty"`
	Name       string                `json:"name"`
	Role       DatabasePrincipalRole `json:"role"`
	TenantName *string               `json:"tenantName,omitempty"`
	Type       DatabasePrincipalType `json:"type"`
}

type DatabasePrincipalListRequest

type DatabasePrincipalListRequest struct {
	Value *[]DatabasePrincipal `json:"value,omitempty"`
}

type DatabasePrincipalListResult

type DatabasePrincipalListResult struct {
	Value *[]DatabasePrincipal `json:"value,omitempty"`
}

type DatabasePrincipalRole

type DatabasePrincipalRole string
const (
	DatabasePrincipalRoleAdmin              DatabasePrincipalRole = "Admin"
	DatabasePrincipalRoleIngestor           DatabasePrincipalRole = "Ingestor"
	DatabasePrincipalRoleMonitor            DatabasePrincipalRole = "Monitor"
	DatabasePrincipalRoleUnrestrictedViewer DatabasePrincipalRole = "UnrestrictedViewer"
	DatabasePrincipalRoleUser               DatabasePrincipalRole = "User"
	DatabasePrincipalRoleViewer             DatabasePrincipalRole = "Viewer"
)

func (*DatabasePrincipalRole) UnmarshalJSON

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

type DatabasePrincipalType

type DatabasePrincipalType string
const (
	DatabasePrincipalTypeApp   DatabasePrincipalType = "App"
	DatabasePrincipalTypeGroup DatabasePrincipalType = "Group"
	DatabasePrincipalTypeUser  DatabasePrincipalType = "User"
)

func (*DatabasePrincipalType) UnmarshalJSON

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

type DatabaseShareOrigin

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

func (*DatabaseShareOrigin) UnmarshalJSON

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

type DatabaseStatistics

type DatabaseStatistics struct {
	Size *float64 `json:"size,omitempty"`
}

type DatabasesClient

type DatabasesClient struct {
	Client *resourcemanager.Client
}

func NewDatabasesClientWithBaseURI

func NewDatabasesClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabasesClient, error)

func (DatabasesClient) AddPrincipals

AddPrincipals ...

func (DatabasesClient) CheckNameAvailability

CheckNameAvailability ...

func (DatabasesClient) CreateOrUpdate

CreateOrUpdate ...

func (DatabasesClient) CreateOrUpdateThenPoll

func (c DatabasesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.KustoDatabaseId, input Database, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DatabasesClient) DatabaseInviteFollower

DatabaseInviteFollower ...

func (DatabasesClient) Delete

Delete ...

func (DatabasesClient) DeleteThenPoll

func (c DatabasesClient) DeleteThenPoll(ctx context.Context, id commonids.KustoDatabaseId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DatabasesClient) Get

Get ...

func (DatabasesClient) ListByCluster

ListByCluster ...

func (DatabasesClient) ListByClusterComplete

ListByClusterComplete retrieves all the results into a single object

func (DatabasesClient) ListByClusterCompleteMatchingPredicate

func (c DatabasesClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id commonids.KustoClusterId, options ListByClusterOperationOptions, predicate DatabaseOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DatabasesClient) ListPrincipals

ListPrincipals ...

func (DatabasesClient) RemovePrincipals

RemovePrincipals ...

func (DatabasesClient) Update

Update ...

func (DatabasesClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

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

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 Kind

type Kind string
const (
	KindReadOnlyFollowing Kind = "ReadOnlyFollowing"
	KindReadWrite         Kind = "ReadWrite"
)

func (*Kind) UnmarshalJSON

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

type ListByClusterCompleteResult

type ListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Database
}

type ListByClusterOperationOptions

type ListByClusterOperationOptions struct {
	Top *int64
}

func DefaultListByClusterOperationOptions

func DefaultListByClusterOperationOptions() ListByClusterOperationOptions

func (ListByClusterOperationOptions) ToHeaders

func (ListByClusterOperationOptions) ToOData

func (ListByClusterOperationOptions) ToQuery

type ListByClusterOperationResponse

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Database
}

type ListPrincipalsOperationResponse

type ListPrincipalsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabasePrincipalListResult
}

type PrincipalsModificationKind

type PrincipalsModificationKind string
const (
	PrincipalsModificationKindNone    PrincipalsModificationKind = "None"
	PrincipalsModificationKindReplace PrincipalsModificationKind = "Replace"
	PrincipalsModificationKindUnion   PrincipalsModificationKind = "Union"
)

func (*PrincipalsModificationKind) UnmarshalJSON

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

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 RawDatabaseImpl

type RawDatabaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawDatabaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ReadOnlyFollowingDatabase

type ReadOnlyFollowingDatabase struct {
	Properties *ReadOnlyFollowingDatabaseProperties `json:"properties,omitempty"`

	// Fields inherited from Database
	Id       *string `json:"id,omitempty"`
	Location *string `json:"location,omitempty"`
	Name     *string `json:"name,omitempty"`
	Type     *string `json:"type,omitempty"`
}

func (ReadOnlyFollowingDatabase) MarshalJSON

func (s ReadOnlyFollowingDatabase) MarshalJSON() ([]byte, error)

type ReadOnlyFollowingDatabaseProperties

type ReadOnlyFollowingDatabaseProperties struct {
	AttachedDatabaseConfigurationName *string                      `json:"attachedDatabaseConfigurationName,omitempty"`
	DatabaseShareOrigin               *DatabaseShareOrigin         `json:"databaseShareOrigin,omitempty"`
	HotCachePeriod                    *string                      `json:"hotCachePeriod,omitempty"`
	LeaderClusterResourceId           *string                      `json:"leaderClusterResourceId,omitempty"`
	OriginalDatabaseName              *string                      `json:"originalDatabaseName,omitempty"`
	PrincipalsModificationKind        *PrincipalsModificationKind  `json:"principalsModificationKind,omitempty"`
	ProvisioningState                 *ProvisioningState           `json:"provisioningState,omitempty"`
	SoftDeletePeriod                  *string                      `json:"softDeletePeriod,omitempty"`
	Statistics                        *DatabaseStatistics          `json:"statistics,omitempty"`
	SuspensionDetails                 *SuspensionDetails           `json:"suspensionDetails,omitempty"`
	TableLevelSharingProperties       *TableLevelSharingProperties `json:"tableLevelSharingProperties,omitempty"`
}

type ReadWriteDatabase

type ReadWriteDatabase struct {
	Properties *ReadWriteDatabaseProperties `json:"properties,omitempty"`

	// Fields inherited from Database
	Id       *string `json:"id,omitempty"`
	Location *string `json:"location,omitempty"`
	Name     *string `json:"name,omitempty"`
	Type     *string `json:"type,omitempty"`
}

func (ReadWriteDatabase) MarshalJSON

func (s ReadWriteDatabase) MarshalJSON() ([]byte, error)

type ReadWriteDatabaseProperties

type ReadWriteDatabaseProperties struct {
	HotCachePeriod     *string             `json:"hotCachePeriod,omitempty"`
	IsFollowed         *bool               `json:"isFollowed,omitempty"`
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
	ProvisioningState  *ProvisioningState  `json:"provisioningState,omitempty"`
	SoftDeletePeriod   *string             `json:"softDeletePeriod,omitempty"`
	Statistics         *DatabaseStatistics `json:"statistics,omitempty"`
	SuspensionDetails  *SuspensionDetails  `json:"suspensionDetails,omitempty"`
}

type Reason

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

func (*Reason) UnmarshalJSON

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

type RemovePrincipalsOperationResponse

type RemovePrincipalsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabasePrincipalListResult
}

type SuspensionDetails

type SuspensionDetails struct {
	SuspensionStartDate *string `json:"suspensionStartDate,omitempty"`
}

func (*SuspensionDetails) GetSuspensionStartDateAsTime

func (o *SuspensionDetails) GetSuspensionStartDateAsTime() (*time.Time, error)

func (*SuspensionDetails) SetSuspensionStartDateAsTime

func (o *SuspensionDetails) SetSuspensionStartDateAsTime(input time.Time)

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 Type

type Type string
const (
	TypeMicrosoftPointKustoClustersAttachedDatabaseConfigurations Type = "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"
	TypeMicrosoftPointKustoClustersDatabases                      Type = "Microsoft.Kusto/clusters/databases"
)

func (*Type) UnmarshalJSON

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

type UpdateOperationOptions

type UpdateOperationOptions struct {
	CallerRole *CallerRole
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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