restorabledroppeddatabases

package
v0.20240527.1094340 Latest Latest
Warning

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

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

README

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

The restorabledroppeddatabases 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/restorabledroppeddatabases"

Client Initialization

client := restorabledroppeddatabases.NewRestorableDroppedDatabasesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RestorableDroppedDatabasesClient.Get

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

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

Example Usage: RestorableDroppedDatabasesClient.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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForBackupStorageRedundancy 

func PossibleValuesForBackupStorageRedundancy() []string

func PossibleValuesForDatabaseKeyType 

func PossibleValuesForDatabaseKeyType() []string

func ValidateRestorableDroppedDatabaseID 

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

ValidateRestorableDroppedDatabaseID checks that 'input' can be parsed as a Restorable Dropped Database ID

Types

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

type ListByServerCompleteResult 

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

type ListByServerOperationResponse 

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

type RestorableDroppedDatabase 

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

type RestorableDroppedDatabaseId 

type RestorableDroppedDatabaseId struct {
	SubscriptionId              string
	ResourceGroupName           string
	ServerName                  string
	RestorableDroppedDatabaseId string
}

RestorableDroppedDatabaseId is a struct representing the Resource ID for a Restorable Dropped Database

func NewRestorableDroppedDatabaseID 

func NewRestorableDroppedDatabaseID(subscriptionId string, resourceGroupName string, serverName string, restorableDroppedDatabaseId string) RestorableDroppedDatabaseId

NewRestorableDroppedDatabaseID returns a new RestorableDroppedDatabaseId struct

func ParseRestorableDroppedDatabaseID 

func ParseRestorableDroppedDatabaseID(input string) (*RestorableDroppedDatabaseId, error)

ParseRestorableDroppedDatabaseID parses 'input' into a RestorableDroppedDatabaseId

func ParseRestorableDroppedDatabaseIDInsensitively 

func ParseRestorableDroppedDatabaseIDInsensitively(input string) (*RestorableDroppedDatabaseId, error)

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

func (*RestorableDroppedDatabaseId) FromParseResult 

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

func (RestorableDroppedDatabaseId) ID 

func (id RestorableDroppedDatabaseId) ID() string

ID returns the formatted Restorable Dropped Database ID

func (RestorableDroppedDatabaseId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Restorable Dropped Database ID

func (RestorableDroppedDatabaseId) String 

func (id RestorableDroppedDatabaseId) String() string

String returns a human-readable description of this Restorable Dropped Database ID

type RestorableDroppedDatabaseOperationPredicate 

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

func (RestorableDroppedDatabaseOperationPredicate) Matches 

func (p RestorableDroppedDatabaseOperationPredicate) Matches(input RestorableDroppedDatabase) bool

type RestorableDroppedDatabaseProperties 

type RestorableDroppedDatabaseProperties struct {
	BackupStorageRedundancy *BackupStorageRedundancy `json:"backupStorageRedundancy,omitempty"`
	CreationDate            *string                  `json:"creationDate,omitempty"`
	DatabaseName            *string                  `json:"databaseName,omitempty"`
	DeletionDate            *string                  `json:"deletionDate,omitempty"`
	EarliestRestoreDate     *string                  `json:"earliestRestoreDate,omitempty"`
	Keys                    *map[string]DatabaseKey  `json:"keys,omitempty"`
	MaxSizeBytes            *int64                   `json:"maxSizeBytes,omitempty"`
}

func (*RestorableDroppedDatabaseProperties) GetCreationDateAsTime 

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

func (*RestorableDroppedDatabaseProperties) GetDeletionDateAsTime 

func (o *RestorableDroppedDatabaseProperties) GetDeletionDateAsTime() (*time.Time, error)

func (*RestorableDroppedDatabaseProperties) GetEarliestRestoreDateAsTime 

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

func (*RestorableDroppedDatabaseProperties) SetCreationDateAsTime 

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

func (*RestorableDroppedDatabaseProperties) SetDeletionDateAsTime 

func (o *RestorableDroppedDatabaseProperties) SetDeletionDateAsTime(input time.Time)

func (*RestorableDroppedDatabaseProperties) SetEarliestRestoreDateAsTime 

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

type RestorableDroppedDatabasesClient 

type RestorableDroppedDatabasesClient struct {
	Client *resourcemanager.Client
}

func NewRestorableDroppedDatabasesClientWithBaseURI 

func NewRestorableDroppedDatabasesClientWithBaseURI(sdkApi sdkEnv.Api) (*RestorableDroppedDatabasesClient, error)

func (RestorableDroppedDatabasesClient) Get 

func (c RestorableDroppedDatabasesClient) Get(ctx context.Context, id RestorableDroppedDatabaseId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (RestorableDroppedDatabasesClient) ListByServer 

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

ListByServer ...

func (RestorableDroppedDatabasesClient) ListByServerComplete 

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

ListByServerComplete retrieves all the results into a single object

func (RestorableDroppedDatabasesClient) ListByServerCompleteMatchingPredicate 

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

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

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.