manageddatabases

package
v0.20240731.1212841 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/manageddatabases Documentation

The manageddatabases SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-01-preview).

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/sql/2023-02-01-preview/manageddatabases"

Client Initialization

client := manageddatabases.NewManagedDatabasesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedDatabasesClient.CancelMove

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

payload := manageddatabases.ManagedDatabaseMoveDefinition{
	// ...
}


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

Example Usage: ManagedDatabasesClient.CompleteMove

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

payload := manageddatabases.ManagedDatabaseMoveDefinition{
	// ...
}


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

Example Usage: ManagedDatabasesClient.CompleteRestore

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

payload := manageddatabases.CompleteDatabaseRestoreDefinition{
	// ...
}


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

Example Usage: ManagedDatabasesClient.CreateOrUpdate

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

payload := manageddatabases.ManagedDatabase{
	// ...
}


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

Example Usage: ManagedDatabasesClient.Delete

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

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

Example Usage: ManagedDatabasesClient.Get

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedDatabasesClient.ListByInstance

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

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

Example Usage: ManagedDatabasesClient.ListInaccessibleByInstance

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

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

Example Usage: ManagedDatabasesClient.StartMove

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

payload := manageddatabases.ManagedDatabaseStartMoveDefinition{
	// ...
}


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

Example Usage: ManagedDatabasesClient.Update

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

payload := manageddatabases.ManagedDatabaseUpdate{
	// ...
}


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 PossibleValuesForCatalogCollationType 

func PossibleValuesForCatalogCollationType() []string

func PossibleValuesForManagedDatabaseCreateMode 

func PossibleValuesForManagedDatabaseCreateMode() []string

func PossibleValuesForManagedDatabaseStatus 

func PossibleValuesForManagedDatabaseStatus() []string

func PossibleValuesForMoveOperationMode 

func PossibleValuesForMoveOperationMode() []string

Types

type CancelMoveOperationResponse 

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

type CatalogCollationType 

type CatalogCollationType string
const (
	CatalogCollationTypeDATABASEDEFAULT             CatalogCollationType = "DATABASE_DEFAULT"
	CatalogCollationTypeSQLLatinOneGeneralCPOneCIAS CatalogCollationType = "SQL_Latin1_General_CP1_CI_AS"
)

func (*CatalogCollationType) UnmarshalJSON 

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

type CompleteDatabaseRestoreDefinition 

type CompleteDatabaseRestoreDefinition struct {
	LastBackupName string `json:"lastBackupName"`
}

type CompleteMoveOperationResponse 

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

type CompleteRestoreOperationResponse 

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

type CreateOrUpdateOperationResponse 

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

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

type ListByInstanceCompleteResult 

type ListByInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedDatabase
}

type ListByInstanceCustomPager added in v0.20240628.1153531 

type ListByInstanceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link

type ListByInstanceOperationResponse 

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedDatabase
}

type ListInaccessibleByInstanceCompleteResult 

type ListInaccessibleByInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedDatabase
}

type ListInaccessibleByInstanceCustomPager added in v0.20240628.1153531 

type ListInaccessibleByInstanceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListInaccessibleByInstanceCustomPager) NextPageLink() *odata.Link

type ListInaccessibleByInstanceOperationResponse 

type ListInaccessibleByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedDatabase
}

type ManagedDatabase 

type ManagedDatabase struct {
	Id         *string                    `json:"id,omitempty"`
	Location   string                     `json:"location"`
	Name       *string                    `json:"name,omitempty"`
	Properties *ManagedDatabaseProperties `json:"properties,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type ManagedDatabaseCreateMode 

type ManagedDatabaseCreateMode string
const (
	ManagedDatabaseCreateModeDefault                        ManagedDatabaseCreateMode = "Default"
	ManagedDatabaseCreateModePointInTimeRestore             ManagedDatabaseCreateMode = "PointInTimeRestore"
	ManagedDatabaseCreateModeRecovery                       ManagedDatabaseCreateMode = "Recovery"
	ManagedDatabaseCreateModeRestoreExternalBackup          ManagedDatabaseCreateMode = "RestoreExternalBackup"
	ManagedDatabaseCreateModeRestoreLongTermRetentionBackup ManagedDatabaseCreateMode = "RestoreLongTermRetentionBackup"
)

func (*ManagedDatabaseCreateMode) UnmarshalJSON 

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

type ManagedDatabaseMoveDefinition 

type ManagedDatabaseMoveDefinition struct {
	DestinationManagedDatabaseId string `json:"destinationManagedDatabaseId"`
}

type ManagedDatabaseOperationPredicate 

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

func (ManagedDatabaseOperationPredicate) Matches 

func (p ManagedDatabaseOperationPredicate) Matches(input ManagedDatabase) bool

type ManagedDatabaseProperties 

type ManagedDatabaseProperties struct {
	AutoCompleteRestore                          *bool                      `json:"autoCompleteRestore,omitempty"`
	CatalogCollation                             *CatalogCollationType      `json:"catalogCollation,omitempty"`
	Collation                                    *string                    `json:"collation,omitempty"`
	CreateMode                                   *ManagedDatabaseCreateMode `json:"createMode,omitempty"`
	CreationDate                                 *string                    `json:"creationDate,omitempty"`
	CrossSubscriptionRestorableDroppedDatabaseId *string                    `json:"crossSubscriptionRestorableDroppedDatabaseId,omitempty"`
	CrossSubscriptionSourceDatabaseId            *string                    `json:"crossSubscriptionSourceDatabaseId,omitempty"`
	CrossSubscriptionTargetManagedInstanceId     *string                    `json:"crossSubscriptionTargetManagedInstanceId,omitempty"`
	DefaultSecondaryLocation                     *string                    `json:"defaultSecondaryLocation,omitempty"`
	EarliestRestorePoint                         *string                    `json:"earliestRestorePoint,omitempty"`
	FailoverGroupId                              *string                    `json:"failoverGroupId,omitempty"`
	IsLedgerOn                                   *bool                      `json:"isLedgerOn,omitempty"`
	LastBackupName                               *string                    `json:"lastBackupName,omitempty"`
	LongTermRetentionBackupResourceId            *string                    `json:"longTermRetentionBackupResourceId,omitempty"`
	RecoverableDatabaseId                        *string                    `json:"recoverableDatabaseId,omitempty"`
	RestorableDroppedDatabaseId                  *string                    `json:"restorableDroppedDatabaseId,omitempty"`
	RestorePointInTime                           *string                    `json:"restorePointInTime,omitempty"`
	SourceDatabaseId                             *string                    `json:"sourceDatabaseId,omitempty"`
	Status                                       *ManagedDatabaseStatus     `json:"status,omitempty"`
	StorageContainerIdentity                     *string                    `json:"storageContainerIdentity,omitempty"`
	StorageContainerSasToken                     *string                    `json:"storageContainerSasToken,omitempty"`
	StorageContainerUri                          *string                    `json:"storageContainerUri,omitempty"`
}

func (*ManagedDatabaseProperties) GetCreationDateAsTime 

func (o *ManagedDatabaseProperties) GetCreationDateAsTime() (*time.Time, error)

func (*ManagedDatabaseProperties) GetEarliestRestorePointAsTime 

func (o *ManagedDatabaseProperties) GetEarliestRestorePointAsTime() (*time.Time, error)

func (*ManagedDatabaseProperties) GetRestorePointInTimeAsTime 

func (o *ManagedDatabaseProperties) GetRestorePointInTimeAsTime() (*time.Time, error)

func (*ManagedDatabaseProperties) SetCreationDateAsTime 

func (o *ManagedDatabaseProperties) SetCreationDateAsTime(input time.Time)

func (*ManagedDatabaseProperties) SetEarliestRestorePointAsTime 

func (o *ManagedDatabaseProperties) SetEarliestRestorePointAsTime(input time.Time)

func (*ManagedDatabaseProperties) SetRestorePointInTimeAsTime 

func (o *ManagedDatabaseProperties) SetRestorePointInTimeAsTime(input time.Time)

type ManagedDatabaseStartMoveDefinition 

type ManagedDatabaseStartMoveDefinition struct {
	DestinationManagedDatabaseId string             `json:"destinationManagedDatabaseId"`
	OperationMode                *MoveOperationMode `json:"operationMode,omitempty"`
}

type ManagedDatabaseStatus 

type ManagedDatabaseStatus string
const (
	ManagedDatabaseStatusCreating     ManagedDatabaseStatus = "Creating"
	ManagedDatabaseStatusDbCopying    ManagedDatabaseStatus = "DbCopying"
	ManagedDatabaseStatusDbMoving     ManagedDatabaseStatus = "DbMoving"
	ManagedDatabaseStatusInaccessible ManagedDatabaseStatus = "Inaccessible"
	ManagedDatabaseStatusOffline      ManagedDatabaseStatus = "Offline"
	ManagedDatabaseStatusOnline       ManagedDatabaseStatus = "Online"
	ManagedDatabaseStatusRestoring    ManagedDatabaseStatus = "Restoring"
	ManagedDatabaseStatusShutdown     ManagedDatabaseStatus = "Shutdown"
	ManagedDatabaseStatusStarting     ManagedDatabaseStatus = "Starting"
	ManagedDatabaseStatusStopped      ManagedDatabaseStatus = "Stopped"
	ManagedDatabaseStatusStopping     ManagedDatabaseStatus = "Stopping"
	ManagedDatabaseStatusUpdating     ManagedDatabaseStatus = "Updating"
)

func (*ManagedDatabaseStatus) UnmarshalJSON 

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

type ManagedDatabaseUpdate 

type ManagedDatabaseUpdate struct {
	Properties *ManagedDatabaseProperties `json:"properties,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
}

type ManagedDatabasesClient 

type ManagedDatabasesClient struct {
	Client *resourcemanager.Client
}

func NewManagedDatabasesClientWithBaseURI 

func NewManagedDatabasesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabasesClient, error)

func (ManagedDatabasesClient) CancelMove 

func (c ManagedDatabasesClient) CancelMove(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseMoveDefinition) (result CancelMoveOperationResponse, err error)

CancelMove ...

func (ManagedDatabasesClient) CancelMoveThenPoll 

func (c ManagedDatabasesClient) CancelMoveThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseMoveDefinition) error

CancelMoveThenPoll performs CancelMove then polls until it's completed

func (ManagedDatabasesClient) CompleteMove 

func (c ManagedDatabasesClient) CompleteMove(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseMoveDefinition) (result CompleteMoveOperationResponse, err error)

CompleteMove ...

func (ManagedDatabasesClient) CompleteMoveThenPoll 

func (c ManagedDatabasesClient) CompleteMoveThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseMoveDefinition) error

CompleteMoveThenPoll performs CompleteMove then polls until it's completed

func (ManagedDatabasesClient) CompleteRestore 

func (c ManagedDatabasesClient) CompleteRestore(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input CompleteDatabaseRestoreDefinition) (result CompleteRestoreOperationResponse, err error)

CompleteRestore ...

func (ManagedDatabasesClient) CompleteRestoreThenPoll 

func (c ManagedDatabasesClient) CompleteRestoreThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input CompleteDatabaseRestoreDefinition) error

CompleteRestoreThenPoll performs CompleteRestore then polls until it's completed

func (ManagedDatabasesClient) CreateOrUpdate 

func (c ManagedDatabasesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabase) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedDatabasesClient) CreateOrUpdateThenPoll 

func (c ManagedDatabasesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabase) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedDatabasesClient) Delete 

func (c ManagedDatabasesClient) Delete(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (result DeleteOperationResponse, err error)

Delete ...

func (ManagedDatabasesClient) DeleteThenPoll 

func (c ManagedDatabasesClient) DeleteThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedDatabasesClient) Get 

func (c ManagedDatabasesClient) Get(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (result GetOperationResponse, err error)

Get ...

func (ManagedDatabasesClient) ListByInstance 

func (c ManagedDatabasesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)

ListByInstance ...

func (ManagedDatabasesClient) ListByInstanceComplete 

func (c ManagedDatabasesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)

ListByInstanceComplete retrieves all the results into a single object

func (ManagedDatabasesClient) ListByInstanceCompleteMatchingPredicate 

func (c ManagedDatabasesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, predicate ManagedDatabaseOperationPredicate) (result ListByInstanceCompleteResult, err error)

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedDatabasesClient) ListInaccessibleByInstance 

func (c ManagedDatabasesClient) ListInaccessibleByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListInaccessibleByInstanceOperationResponse, err error)

ListInaccessibleByInstance ...

func (ManagedDatabasesClient) ListInaccessibleByInstanceComplete 

func (c ManagedDatabasesClient) ListInaccessibleByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListInaccessibleByInstanceCompleteResult, error)

ListInaccessibleByInstanceComplete retrieves all the results into a single object

func (ManagedDatabasesClient) ListInaccessibleByInstanceCompleteMatchingPredicate 

func (c ManagedDatabasesClient) ListInaccessibleByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, predicate ManagedDatabaseOperationPredicate) (result ListInaccessibleByInstanceCompleteResult, err error)

ListInaccessibleByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedDatabasesClient) StartMove 

func (c ManagedDatabasesClient) StartMove(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseStartMoveDefinition) (result StartMoveOperationResponse, err error)

StartMove ...

func (ManagedDatabasesClient) StartMoveThenPoll 

func (c ManagedDatabasesClient) StartMoveThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseStartMoveDefinition) error

StartMoveThenPoll performs StartMove then polls until it's completed

func (ManagedDatabasesClient) Update 

func (c ManagedDatabasesClient) Update(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseUpdate) (result UpdateOperationResponse, err error)

Update ...

func (ManagedDatabasesClient) UpdateThenPoll 

func (c ManagedDatabasesClient) UpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedDatabaseUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type MoveOperationMode 

type MoveOperationMode string
const (
	MoveOperationModeCopy MoveOperationMode = "Copy"
	MoveOperationModeMove MoveOperationMode = "Move"
)

func (*MoveOperationMode) UnmarshalJSON 

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

type StartMoveOperationResponse 

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

type UpdateOperationResponse 

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

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.