databases

package
v0.20240708.1080555 Latest Latest
Warning

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

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

README

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

The databases SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-05-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-05-01-preview/databases"

Client Initialization

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

Example Usage: DatabasesClient.CreateOrUpdate

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

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


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

Example Usage: DatabasesClient.Delete

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

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

Example Usage: DatabasesClient.Export

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

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


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

Example Usage: DatabasesClient.Failover

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

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

Example Usage: DatabasesClient.Get

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

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

Example Usage: DatabasesClient.Import

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

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


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

Example Usage: DatabasesClient.ListByElasticPool

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

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

Example Usage: DatabasesClient.ListByServer

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

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

Example Usage: DatabasesClient.ListInaccessibleByServer

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

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

Example Usage: DatabasesClient.Pause

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

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

Example Usage: DatabasesClient.Rename

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

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


read, err := client.Rename(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.Resume

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

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

Example Usage: DatabasesClient.Update

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

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


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

Example Usage: DatabasesClient.UpgradeDataWarehouse

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAlwaysEncryptedEnclaveType 

func PossibleValuesForAlwaysEncryptedEnclaveType() []string

func PossibleValuesForAvailabilityZoneType 

func PossibleValuesForAvailabilityZoneType() []string

func PossibleValuesForBackupStorageRedundancy 

func PossibleValuesForBackupStorageRedundancy() []string

func PossibleValuesForCatalogCollationType 

func PossibleValuesForCatalogCollationType() []string

func PossibleValuesForCreateMode 

func PossibleValuesForCreateMode() []string

func PossibleValuesForDatabaseKeyType 

func PossibleValuesForDatabaseKeyType() []string

func PossibleValuesForDatabaseLicenseType 

func PossibleValuesForDatabaseLicenseType() []string

func PossibleValuesForDatabaseReadScale 

func PossibleValuesForDatabaseReadScale() []string

func PossibleValuesForDatabaseStatus 

func PossibleValuesForDatabaseStatus() []string

func PossibleValuesForFreeLimitExhaustionBehavior 

func PossibleValuesForFreeLimitExhaustionBehavior() []string

func PossibleValuesForReplicaType 

func PossibleValuesForReplicaType() []string

func PossibleValuesForSampleName 

func PossibleValuesForSampleName() []string

func PossibleValuesForSecondaryType 

func PossibleValuesForSecondaryType() []string

func PossibleValuesForStorageKeyType 

func PossibleValuesForStorageKeyType() []string

Types

type AlwaysEncryptedEnclaveType 

type AlwaysEncryptedEnclaveType string
const (
	AlwaysEncryptedEnclaveTypeDefault AlwaysEncryptedEnclaveType = "Default"
	AlwaysEncryptedEnclaveTypeVBS     AlwaysEncryptedEnclaveType = "VBS"
)

func (*AlwaysEncryptedEnclaveType) UnmarshalJSON 

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

type AvailabilityZoneType 

type AvailabilityZoneType string
const (
	AvailabilityZoneTypeNoPreference AvailabilityZoneType = "NoPreference"
	AvailabilityZoneTypeOne          AvailabilityZoneType = "1"
	AvailabilityZoneTypeThree        AvailabilityZoneType = "3"
	AvailabilityZoneTypeTwo          AvailabilityZoneType = "2"
)

func (*AvailabilityZoneType) UnmarshalJSON 

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

type BackupStorageRedundancy 

type BackupStorageRedundancy string
const (
	BackupStorageRedundancyGeo     BackupStorageRedundancy = "Geo"
	BackupStorageRedundancyGeoZone BackupStorageRedundancy = "GeoZone"
	BackupStorageRedundancyLocal   BackupStorageRedundancy = "Local"
	BackupStorageRedundancyZone    BackupStorageRedundancy = "Zone"
)

func (*BackupStorageRedundancy) UnmarshalJSON 

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

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 CreateMode 

type CreateMode string
const (
	CreateModeCopy                           CreateMode = "Copy"
	CreateModeDefault                        CreateMode = "Default"
	CreateModeOnlineSecondary                CreateMode = "OnlineSecondary"
	CreateModePointInTimeRestore             CreateMode = "PointInTimeRestore"
	CreateModeRecovery                       CreateMode = "Recovery"
	CreateModeRestore                        CreateMode = "Restore"
	CreateModeRestoreExternalBackup          CreateMode = "RestoreExternalBackup"
	CreateModeRestoreExternalBackupSecondary CreateMode = "RestoreExternalBackupSecondary"
	CreateModeRestoreLongTermRetentionBackup CreateMode = "RestoreLongTermRetentionBackup"
	CreateModeSecondary                      CreateMode = "Secondary"
)

func (*CreateMode) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type Database 

type Database struct {
	Id         *string                   `json:"id,omitempty"`
	Identity   *identity.UserAssignedMap `json:"identity,omitempty"`
	Kind       *string                   `json:"kind,omitempty"`
	Location   string                    `json:"location"`
	ManagedBy  *string                   `json:"managedBy,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *DatabaseProperties       `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type DatabaseKey 

type DatabaseKey struct {
	CreationDate *string          `json:"creationDate,omitempty"`
	Subregion    *string          `json:"subregion,omitempty"`
	Thumbprint   *string          `json:"thumbprint,omitempty"`
	Type         *DatabaseKeyType `json:"type,omitempty"`
}

func (*DatabaseKey) GetCreationDateAsTime 

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

func (*DatabaseKey) SetCreationDateAsTime 

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

type DatabaseKeyType 

type DatabaseKeyType string
const (
	DatabaseKeyTypeAzureKeyVault DatabaseKeyType = "AzureKeyVault"
)

func (*DatabaseKeyType) UnmarshalJSON 

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

type DatabaseLicenseType 

type DatabaseLicenseType string
const (
	DatabaseLicenseTypeBasePrice       DatabaseLicenseType = "BasePrice"
	DatabaseLicenseTypeLicenseIncluded DatabaseLicenseType = "LicenseIncluded"
)

func (*DatabaseLicenseType) UnmarshalJSON 

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

type DatabaseOperationPredicate 

type DatabaseOperationPredicate struct {
	Id        *string
	Kind      *string
	Location  *string
	ManagedBy *string
	Name      *string
	Type      *string
}

func (DatabaseOperationPredicate) Matches 

func (p DatabaseOperationPredicate) Matches(input Database) bool

type DatabaseProperties 

type DatabaseProperties struct {
	AutoPauseDelay                    *int64                       `json:"autoPauseDelay,omitempty"`
	AvailabilityZone                  *AvailabilityZoneType        `json:"availabilityZone,omitempty"`
	CatalogCollation                  *CatalogCollationType        `json:"catalogCollation,omitempty"`
	Collation                         *string                      `json:"collation,omitempty"`
	CreateMode                        *CreateMode                  `json:"createMode,omitempty"`
	CreationDate                      *string                      `json:"creationDate,omitempty"`
	CurrentBackupStorageRedundancy    *BackupStorageRedundancy     `json:"currentBackupStorageRedundancy,omitempty"`
	CurrentServiceObjectiveName       *string                      `json:"currentServiceObjectiveName,omitempty"`
	CurrentSku                        *Sku                         `json:"currentSku,omitempty"`
	DatabaseId                        *string                      `json:"databaseId,omitempty"`
	DefaultSecondaryLocation          *string                      `json:"defaultSecondaryLocation,omitempty"`
	EarliestRestoreDate               *string                      `json:"earliestRestoreDate,omitempty"`
	ElasticPoolId                     *string                      `json:"elasticPoolId,omitempty"`
	EncryptionProtector               *string                      `json:"encryptionProtector,omitempty"`
	EncryptionProtectorAutoRotation   *bool                        `json:"encryptionProtectorAutoRotation,omitempty"`
	FailoverGroupId                   *string                      `json:"failoverGroupId,omitempty"`
	FederatedClientId                 *string                      `json:"federatedClientId,omitempty"`
	FreeLimitExhaustionBehavior       *FreeLimitExhaustionBehavior `json:"freeLimitExhaustionBehavior,omitempty"`
	HighAvailabilityReplicaCount      *int64                       `json:"highAvailabilityReplicaCount,omitempty"`
	IsInfraEncryptionEnabled          *bool                        `json:"isInfraEncryptionEnabled,omitempty"`
	IsLedgerOn                        *bool                        `json:"isLedgerOn,omitempty"`
	Keys                              *map[string]DatabaseKey      `json:"keys,omitempty"`
	LicenseType                       *DatabaseLicenseType         `json:"licenseType,omitempty"`
	LongTermRetentionBackupResourceId *string                      `json:"longTermRetentionBackupResourceId,omitempty"`
	MaintenanceConfigurationId        *string                      `json:"maintenanceConfigurationId,omitempty"`
	ManualCutover                     *bool                        `json:"manualCutover,omitempty"`
	MaxLogSizeBytes                   *int64                       `json:"maxLogSizeBytes,omitempty"`
	MaxSizeBytes                      *int64                       `json:"maxSizeBytes,omitempty"`
	MinCapacity                       *float64                     `json:"minCapacity,omitempty"`
	PausedDate                        *string                      `json:"pausedDate,omitempty"`
	PerformCutover                    *bool                        `json:"performCutover,omitempty"`
	PreferredEnclaveType              *AlwaysEncryptedEnclaveType  `json:"preferredEnclaveType,omitempty"`
	ReadScale                         *DatabaseReadScale           `json:"readScale,omitempty"`
	RecoverableDatabaseId             *string                      `json:"recoverableDatabaseId,omitempty"`
	RecoveryServicesRecoveryPointId   *string                      `json:"recoveryServicesRecoveryPointId,omitempty"`
	RequestedBackupStorageRedundancy  *BackupStorageRedundancy     `json:"requestedBackupStorageRedundancy,omitempty"`
	RequestedServiceObjectiveName     *string                      `json:"requestedServiceObjectiveName,omitempty"`
	RestorableDroppedDatabaseId       *string                      `json:"restorableDroppedDatabaseId,omitempty"`
	RestorePointInTime                *string                      `json:"restorePointInTime,omitempty"`
	ResumedDate                       *string                      `json:"resumedDate,omitempty"`
	SampleName                        *SampleName                  `json:"sampleName,omitempty"`
	SecondaryType                     *SecondaryType               `json:"secondaryType,omitempty"`
	SourceDatabaseDeletionDate        *string                      `json:"sourceDatabaseDeletionDate,omitempty"`
	SourceDatabaseId                  *string                      `json:"sourceDatabaseId,omitempty"`
	SourceResourceId                  *string                      `json:"sourceResourceId,omitempty"`
	Status                            *DatabaseStatus              `json:"status,omitempty"`
	UseFreeLimit                      *bool                        `json:"useFreeLimit,omitempty"`
	ZoneRedundant                     *bool                        `json:"zoneRedundant,omitempty"`
}

func (*DatabaseProperties) GetCreationDateAsTime 

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

func (*DatabaseProperties) GetEarliestRestoreDateAsTime 

func (o *DatabaseProperties) GetEarliestRestoreDateAsTime() (*time.Time, error)

func (*DatabaseProperties) GetPausedDateAsTime 

func (o *DatabaseProperties) GetPausedDateAsTime() (*time.Time, error)

func (*DatabaseProperties) GetRestorePointInTimeAsTime 

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

func (*DatabaseProperties) GetResumedDateAsTime 

func (o *DatabaseProperties) GetResumedDateAsTime() (*time.Time, error)

func (*DatabaseProperties) GetSourceDatabaseDeletionDateAsTime 

func (o *DatabaseProperties) GetSourceDatabaseDeletionDateAsTime() (*time.Time, error)

func (*DatabaseProperties) SetCreationDateAsTime 

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

func (*DatabaseProperties) SetEarliestRestoreDateAsTime 

func (o *DatabaseProperties) SetEarliestRestoreDateAsTime(input time.Time)

func (*DatabaseProperties) SetPausedDateAsTime 

func (o *DatabaseProperties) SetPausedDateAsTime(input time.Time)

func (*DatabaseProperties) SetRestorePointInTimeAsTime 

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

func (*DatabaseProperties) SetResumedDateAsTime 

func (o *DatabaseProperties) SetResumedDateAsTime(input time.Time)

func (*DatabaseProperties) SetSourceDatabaseDeletionDateAsTime 

func (o *DatabaseProperties) SetSourceDatabaseDeletionDateAsTime(input time.Time)

type DatabaseReadScale 

type DatabaseReadScale string
const (
	DatabaseReadScaleDisabled DatabaseReadScale = "Disabled"
	DatabaseReadScaleEnabled  DatabaseReadScale = "Enabled"
)

func (*DatabaseReadScale) UnmarshalJSON 

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

type DatabaseStatus 

type DatabaseStatus string
const (
	DatabaseStatusAutoClosed                        DatabaseStatus = "AutoClosed"
	DatabaseStatusCopying                           DatabaseStatus = "Copying"
	DatabaseStatusCreating                          DatabaseStatus = "Creating"
	DatabaseStatusDisabled                          DatabaseStatus = "Disabled"
	DatabaseStatusEmergencyMode                     DatabaseStatus = "EmergencyMode"
	DatabaseStatusInaccessible                      DatabaseStatus = "Inaccessible"
	DatabaseStatusOffline                           DatabaseStatus = "Offline"
	DatabaseStatusOfflineChangingDwPerformanceTiers DatabaseStatus = "OfflineChangingDwPerformanceTiers"
	DatabaseStatusOfflineSecondary                  DatabaseStatus = "OfflineSecondary"
	DatabaseStatusOnline                            DatabaseStatus = "Online"
	DatabaseStatusOnlineChangingDwPerformanceTiers  DatabaseStatus = "OnlineChangingDwPerformanceTiers"
	DatabaseStatusPaused                            DatabaseStatus = "Paused"
	DatabaseStatusPausing                           DatabaseStatus = "Pausing"
	DatabaseStatusRecovering                        DatabaseStatus = "Recovering"
	DatabaseStatusRecoveryPending                   DatabaseStatus = "RecoveryPending"
	DatabaseStatusRestoring                         DatabaseStatus = "Restoring"
	DatabaseStatusResuming                          DatabaseStatus = "Resuming"
	DatabaseStatusScaling                           DatabaseStatus = "Scaling"
	DatabaseStatusShutdown                          DatabaseStatus = "Shutdown"
	DatabaseStatusStandby                           DatabaseStatus = "Standby"
	DatabaseStatusStarting                          DatabaseStatus = "Starting"
	DatabaseStatusStopped                           DatabaseStatus = "Stopped"
	DatabaseStatusStopping                          DatabaseStatus = "Stopping"
	DatabaseStatusSuspect                           DatabaseStatus = "Suspect"
)

func (*DatabaseStatus) UnmarshalJSON 

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

type DatabaseUpdate 

type DatabaseUpdate struct {
	Identity   *identity.UserAssignedMap `json:"identity,omitempty"`
	Properties *DatabaseUpdateProperties `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
}

type DatabaseUpdateProperties 

type DatabaseUpdateProperties struct {
	AutoPauseDelay                    *int64                       `json:"autoPauseDelay,omitempty"`
	CatalogCollation                  *CatalogCollationType        `json:"catalogCollation,omitempty"`
	Collation                         *string                      `json:"collation,omitempty"`
	CreateMode                        *CreateMode                  `json:"createMode,omitempty"`
	CreationDate                      *string                      `json:"creationDate,omitempty"`
	CurrentBackupStorageRedundancy    *BackupStorageRedundancy     `json:"currentBackupStorageRedundancy,omitempty"`
	CurrentServiceObjectiveName       *string                      `json:"currentServiceObjectiveName,omitempty"`
	CurrentSku                        *Sku                         `json:"currentSku,omitempty"`
	DatabaseId                        *string                      `json:"databaseId,omitempty"`
	DefaultSecondaryLocation          *string                      `json:"defaultSecondaryLocation,omitempty"`
	EarliestRestoreDate               *string                      `json:"earliestRestoreDate,omitempty"`
	ElasticPoolId                     *string                      `json:"elasticPoolId,omitempty"`
	EncryptionProtector               *string                      `json:"encryptionProtector,omitempty"`
	EncryptionProtectorAutoRotation   *bool                        `json:"encryptionProtectorAutoRotation,omitempty"`
	FailoverGroupId                   *string                      `json:"failoverGroupId,omitempty"`
	FederatedClientId                 *string                      `json:"federatedClientId,omitempty"`
	FreeLimitExhaustionBehavior       *FreeLimitExhaustionBehavior `json:"freeLimitExhaustionBehavior,omitempty"`
	HighAvailabilityReplicaCount      *int64                       `json:"highAvailabilityReplicaCount,omitempty"`
	IsInfraEncryptionEnabled          *bool                        `json:"isInfraEncryptionEnabled,omitempty"`
	IsLedgerOn                        *bool                        `json:"isLedgerOn,omitempty"`
	Keys                              *map[string]DatabaseKey      `json:"keys,omitempty"`
	LicenseType                       *DatabaseLicenseType         `json:"licenseType,omitempty"`
	LongTermRetentionBackupResourceId *string                      `json:"longTermRetentionBackupResourceId,omitempty"`
	MaintenanceConfigurationId        *string                      `json:"maintenanceConfigurationId,omitempty"`
	ManualCutover                     *bool                        `json:"manualCutover,omitempty"`
	MaxLogSizeBytes                   *int64                       `json:"maxLogSizeBytes,omitempty"`
	MaxSizeBytes                      *int64                       `json:"maxSizeBytes,omitempty"`
	MinCapacity                       *float64                     `json:"minCapacity,omitempty"`
	PausedDate                        *string                      `json:"pausedDate,omitempty"`
	PerformCutover                    *bool                        `json:"performCutover,omitempty"`
	PreferredEnclaveType              *AlwaysEncryptedEnclaveType  `json:"preferredEnclaveType,omitempty"`
	ReadScale                         *DatabaseReadScale           `json:"readScale,omitempty"`
	RecoverableDatabaseId             *string                      `json:"recoverableDatabaseId,omitempty"`
	RecoveryServicesRecoveryPointId   *string                      `json:"recoveryServicesRecoveryPointId,omitempty"`
	RequestedBackupStorageRedundancy  *BackupStorageRedundancy     `json:"requestedBackupStorageRedundancy,omitempty"`
	RequestedServiceObjectiveName     *string                      `json:"requestedServiceObjectiveName,omitempty"`
	RestorableDroppedDatabaseId       *string                      `json:"restorableDroppedDatabaseId,omitempty"`
	RestorePointInTime                *string                      `json:"restorePointInTime,omitempty"`
	ResumedDate                       *string                      `json:"resumedDate,omitempty"`
	SampleName                        *SampleName                  `json:"sampleName,omitempty"`
	SecondaryType                     *SecondaryType               `json:"secondaryType,omitempty"`
	SourceDatabaseDeletionDate        *string                      `json:"sourceDatabaseDeletionDate,omitempty"`
	SourceDatabaseId                  *string                      `json:"sourceDatabaseId,omitempty"`
	Status                            *DatabaseStatus              `json:"status,omitempty"`
	UseFreeLimit                      *bool                        `json:"useFreeLimit,omitempty"`
	ZoneRedundant                     *bool                        `json:"zoneRedundant,omitempty"`
}

func (*DatabaseUpdateProperties) GetCreationDateAsTime 

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

func (*DatabaseUpdateProperties) GetEarliestRestoreDateAsTime 

func (o *DatabaseUpdateProperties) GetEarliestRestoreDateAsTime() (*time.Time, error)

func (*DatabaseUpdateProperties) GetPausedDateAsTime 

func (o *DatabaseUpdateProperties) GetPausedDateAsTime() (*time.Time, error)

func (*DatabaseUpdateProperties) GetRestorePointInTimeAsTime 

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

func (*DatabaseUpdateProperties) GetResumedDateAsTime 

func (o *DatabaseUpdateProperties) GetResumedDateAsTime() (*time.Time, error)

func (*DatabaseUpdateProperties) GetSourceDatabaseDeletionDateAsTime 

func (o *DatabaseUpdateProperties) GetSourceDatabaseDeletionDateAsTime() (*time.Time, error)

func (*DatabaseUpdateProperties) SetCreationDateAsTime 

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

func (*DatabaseUpdateProperties) SetEarliestRestoreDateAsTime 

func (o *DatabaseUpdateProperties) SetEarliestRestoreDateAsTime(input time.Time)

func (*DatabaseUpdateProperties) SetPausedDateAsTime 

func (o *DatabaseUpdateProperties) SetPausedDateAsTime(input time.Time)

func (*DatabaseUpdateProperties) SetRestorePointInTimeAsTime 

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

func (*DatabaseUpdateProperties) SetResumedDateAsTime 

func (o *DatabaseUpdateProperties) SetResumedDateAsTime(input time.Time)

func (*DatabaseUpdateProperties) SetSourceDatabaseDeletionDateAsTime 

func (o *DatabaseUpdateProperties) SetSourceDatabaseDeletionDateAsTime(input time.Time)

type DatabasesClient 

type DatabasesClient struct {
	Client *resourcemanager.Client
}

func NewDatabasesClientWithBaseURI 

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

func (DatabasesClient) CreateOrUpdate 

func (c DatabasesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlDatabaseId, input Database) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DatabasesClient) CreateOrUpdateThenPoll 

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

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DatabasesClient) Delete 

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

Delete ...

func (DatabasesClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (DatabasesClient) Export 

func (c DatabasesClient) Export(ctx context.Context, id commonids.SqlDatabaseId, input ExportDatabaseDefinition) (result ExportOperationResponse, err error)

Export ...

func (DatabasesClient) ExportThenPoll 

func (c DatabasesClient) ExportThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input ExportDatabaseDefinition) error

ExportThenPoll performs Export then polls until it's completed

func (DatabasesClient) Failover 

func (c DatabasesClient) Failover(ctx context.Context, id commonids.SqlDatabaseId, options FailoverOperationOptions) (result FailoverOperationResponse, err error)

Failover ...

func (DatabasesClient) FailoverThenPoll 

func (c DatabasesClient) FailoverThenPoll(ctx context.Context, id commonids.SqlDatabaseId, options FailoverOperationOptions) error

FailoverThenPoll performs Failover then polls until it's completed

func (DatabasesClient) Get 

func (c DatabasesClient) Get(ctx context.Context, id commonids.SqlDatabaseId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (DatabasesClient) Import 

func (c DatabasesClient) Import(ctx context.Context, id commonids.SqlDatabaseId, input ImportExistingDatabaseDefinition) (result ImportOperationResponse, err error)

Import ...

func (DatabasesClient) ImportThenPoll 

func (c DatabasesClient) ImportThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input ImportExistingDatabaseDefinition) error

ImportThenPoll performs Import then polls until it's completed

func (DatabasesClient) ListByElasticPool 

func (c DatabasesClient) ListByElasticPool(ctx context.Context, id commonids.SqlElasticPoolId) (result ListByElasticPoolOperationResponse, err error)

ListByElasticPool ...

func (DatabasesClient) ListByElasticPoolComplete 

func (c DatabasesClient) ListByElasticPoolComplete(ctx context.Context, id commonids.SqlElasticPoolId) (ListByElasticPoolCompleteResult, error)

ListByElasticPoolComplete retrieves all the results into a single object

func (DatabasesClient) ListByElasticPoolCompleteMatchingPredicate 

func (c DatabasesClient) ListByElasticPoolCompleteMatchingPredicate(ctx context.Context, id commonids.SqlElasticPoolId, predicate DatabaseOperationPredicate) (result ListByElasticPoolCompleteResult, err error)

ListByElasticPoolCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DatabasesClient) ListByServer 

func (c DatabasesClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (DatabasesClient) ListByServerComplete 

func (c DatabasesClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (DatabasesClient) ListByServerCompleteMatchingPredicate 

func (c DatabasesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate DatabaseOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DatabasesClient) ListInaccessibleByServer 

func (c DatabasesClient) ListInaccessibleByServer(ctx context.Context, id commonids.SqlServerId) (result ListInaccessibleByServerOperationResponse, err error)

ListInaccessibleByServer ...

func (DatabasesClient) ListInaccessibleByServerComplete 

func (c DatabasesClient) ListInaccessibleByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListInaccessibleByServerCompleteResult, error)

ListInaccessibleByServerComplete retrieves all the results into a single object

func (DatabasesClient) ListInaccessibleByServerCompleteMatchingPredicate 

func (c DatabasesClient) ListInaccessibleByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate DatabaseOperationPredicate) (result ListInaccessibleByServerCompleteResult, err error)

ListInaccessibleByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DatabasesClient) Pause 

func (c DatabasesClient) Pause(ctx context.Context, id commonids.SqlDatabaseId) (result PauseOperationResponse, err error)

Pause ...

func (DatabasesClient) PauseThenPoll 

func (c DatabasesClient) PauseThenPoll(ctx context.Context, id commonids.SqlDatabaseId) error

PauseThenPoll performs Pause then polls until it's completed

func (DatabasesClient) Rename 

func (c DatabasesClient) Rename(ctx context.Context, id commonids.SqlDatabaseId, input ResourceMoveDefinition) (result RenameOperationResponse, err error)

Rename ...

func (DatabasesClient) Resume 

func (c DatabasesClient) Resume(ctx context.Context, id commonids.SqlDatabaseId) (result ResumeOperationResponse, err error)

Resume ...

func (DatabasesClient) ResumeThenPoll 

func (c DatabasesClient) ResumeThenPoll(ctx context.Context, id commonids.SqlDatabaseId) error

ResumeThenPoll performs Resume then polls until it's completed

func (DatabasesClient) Update 

func (c DatabasesClient) Update(ctx context.Context, id commonids.SqlDatabaseId, input DatabaseUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DatabasesClient) UpdateThenPoll 

func (c DatabasesClient) UpdateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input DatabaseUpdate) error

UpdateThenPoll performs Update then polls until it's completed

func (DatabasesClient) UpgradeDataWarehouse 

func (c DatabasesClient) UpgradeDataWarehouse(ctx context.Context, id commonids.SqlDatabaseId) (result UpgradeDataWarehouseOperationResponse, err error)

UpgradeDataWarehouse ...

func (DatabasesClient) UpgradeDataWarehouseThenPoll 

func (c DatabasesClient) UpgradeDataWarehouseThenPoll(ctx context.Context, id commonids.SqlDatabaseId) error

UpgradeDataWarehouseThenPoll performs UpgradeDataWarehouse then polls until it's completed

type DeleteOperationResponse 

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

type ExportDatabaseDefinition 

type ExportDatabaseDefinition struct {
	AdministratorLogin         string                    `json:"administratorLogin"`
	AdministratorLoginPassword string                    `json:"administratorLoginPassword"`
	AuthenticationType         *string                   `json:"authenticationType,omitempty"`
	NetworkIsolation           *NetworkIsolationSettings `json:"networkIsolation,omitempty"`
	StorageKey                 string                    `json:"storageKey"`
	StorageKeyType             StorageKeyType            `json:"storageKeyType"`
	StorageUri                 string                    `json:"storageUri"`
}

type ExportOperationResponse 

type ExportOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ImportExportOperationResult
}

type FailoverOperationOptions 

type FailoverOperationOptions struct {
	ReplicaType *ReplicaType
}

func DefaultFailoverOperationOptions 

func DefaultFailoverOperationOptions() FailoverOperationOptions

func (FailoverOperationOptions) ToHeaders 

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

func (FailoverOperationOptions) ToOData 

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

func (FailoverOperationOptions) ToQuery 

func (o FailoverOperationOptions) ToQuery() *client.QueryParams

type FailoverOperationResponse 

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

type FreeLimitExhaustionBehavior 

type FreeLimitExhaustionBehavior string
const (
	FreeLimitExhaustionBehaviorAutoPause     FreeLimitExhaustionBehavior = "AutoPause"
	FreeLimitExhaustionBehaviorBillOverUsage FreeLimitExhaustionBehavior = "BillOverUsage"
)

func (*FreeLimitExhaustionBehavior) UnmarshalJSON 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
	Filter *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

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

func (GetOperationOptions) ToOData 

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

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Database
}

type ImportExistingDatabaseDefinition 

type ImportExistingDatabaseDefinition struct {
	AdministratorLogin         string                    `json:"administratorLogin"`
	AdministratorLoginPassword string                    `json:"administratorLoginPassword"`
	AuthenticationType         *string                   `json:"authenticationType,omitempty"`
	NetworkIsolation           *NetworkIsolationSettings `json:"networkIsolation,omitempty"`
	StorageKey                 string                    `json:"storageKey"`
	StorageKeyType             StorageKeyType            `json:"storageKeyType"`
	StorageUri                 string                    `json:"storageUri"`
}

type ImportExportOperationResult 

type ImportExportOperationResult struct {
	Id         *string                                `json:"id,omitempty"`
	Name       *string                                `json:"name,omitempty"`
	Properties *ImportExportOperationResultProperties `json:"properties,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

type ImportExportOperationResultProperties 

type ImportExportOperationResultProperties struct {
	BlobUri                    *string                                   `json:"blobUri,omitempty"`
	DatabaseName               *string                                   `json:"databaseName,omitempty"`
	ErrorMessage               *string                                   `json:"errorMessage,omitempty"`
	LastModifiedTime           *string                                   `json:"lastModifiedTime,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnectionRequestStatus `json:"privateEndpointConnections,omitempty"`
	QueuedTime                 *string                                   `json:"queuedTime,omitempty"`
	RequestId                  *string                                   `json:"requestId,omitempty"`
	RequestType                *string                                   `json:"requestType,omitempty"`
	ServerName                 *string                                   `json:"serverName,omitempty"`
	Status                     *string                                   `json:"status,omitempty"`
}

type ImportOperationResponse 

type ImportOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ImportExportOperationResult
}

type ListByElasticPoolCompleteResult 

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

type ListByElasticPoolCustomPager added in v0.20240628.1153531 

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

type ListByElasticPoolOperationResponse 

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

type ListByServerCompleteResult 

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

type ListByServerCustomPager added in v0.20240628.1153531 

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

type ListByServerOperationResponse 

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

type ListInaccessibleByServerCompleteResult 

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

type ListInaccessibleByServerCustomPager added in v0.20240628.1153531 

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

type ListInaccessibleByServerOperationResponse 

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

type NetworkIsolationSettings 

type NetworkIsolationSettings struct {
	SqlServerResourceId      *string `json:"sqlServerResourceId,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
}

type PauseOperationResponse 

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

type PrivateEndpointConnectionRequestStatus 

type PrivateEndpointConnectionRequestStatus struct {
	PrivateEndpointConnectionName *string `json:"privateEndpointConnectionName,omitempty"`
	PrivateLinkServiceId          *string `json:"privateLinkServiceId,omitempty"`
	Status                        *string `json:"status,omitempty"`
}

type RenameOperationResponse 

type RenameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ReplicaType 

type ReplicaType string
const (
	ReplicaTypePrimary           ReplicaType = "Primary"
	ReplicaTypeReadableSecondary ReplicaType = "ReadableSecondary"
)

func (*ReplicaType) UnmarshalJSON 

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

type ResourceMoveDefinition 

type ResourceMoveDefinition struct {
	Id string `json:"id"`
}

type ResumeOperationResponse 

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

type SampleName 

type SampleName string
const (
	SampleNameAdventureWorksLT       SampleName = "AdventureWorksLT"
	SampleNameWideWorldImportersFull SampleName = "WideWorldImportersFull"
	SampleNameWideWorldImportersStd  SampleName = "WideWorldImportersStd"
)

func (*SampleName) UnmarshalJSON 

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

type SecondaryType 

type SecondaryType string
const (
	SecondaryTypeGeo     SecondaryType = "Geo"
	SecondaryTypeNamed   SecondaryType = "Named"
	SecondaryTypeStandby SecondaryType = "Standby"
)

func (*SecondaryType) UnmarshalJSON 

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

type Sku 

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Name     string  `json:"name"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type StorageKeyType 

type StorageKeyType string
const (
	StorageKeyTypeSharedAccessKey  StorageKeyType = "SharedAccessKey"
	StorageKeyTypeStorageAccessKey StorageKeyType = "StorageAccessKey"
)

func (*StorageKeyType) UnmarshalJSON 

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

type UpdateOperationResponse 

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

type UpgradeDataWarehouseOperationResponse 

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

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.