recoverablemanageddatabases

README

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

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

Client Initialization

client := recoverablemanageddatabases.NewRecoverableManagedDatabasesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoverableManagedDatabasesClient.Get

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

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: RecoverableManagedDatabasesClient.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
}

Documentation

Index

• func ValidateManagedInstanceRecoverableDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListByInstanceCompleteResult
• type ListByInstanceCustomPager
  • func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link
• type ListByInstanceOperationResponse
• type ManagedInstanceRecoverableDatabaseId
  • func NewManagedInstanceRecoverableDatabaseID(subscriptionId string, resourceGroupName string, managedInstanceName string, ...) ManagedInstanceRecoverableDatabaseId
  • func ParseManagedInstanceRecoverableDatabaseID(input string) (*ManagedInstanceRecoverableDatabaseId, error)
  • func ParseManagedInstanceRecoverableDatabaseIDInsensitively(input string) (*ManagedInstanceRecoverableDatabaseId, error)
  • func (id *ManagedInstanceRecoverableDatabaseId) FromParseResult(input resourceids.ParseResult) error
  • func (id ManagedInstanceRecoverableDatabaseId) ID() string
  • func (id ManagedInstanceRecoverableDatabaseId) Segments() []resourceids.Segment
  • func (id ManagedInstanceRecoverableDatabaseId) String() string
• type RecoverableManagedDatabase
• type RecoverableManagedDatabaseOperationPredicate
  • func (p RecoverableManagedDatabaseOperationPredicate) Matches(input RecoverableManagedDatabase) bool
• type RecoverableManagedDatabaseProperties
• type RecoverableManagedDatabasesClient
  • func NewRecoverableManagedDatabasesClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoverableManagedDatabasesClient, error)
  • func (c RecoverableManagedDatabasesClient) Get(ctx context.Context, id ManagedInstanceRecoverableDatabaseId) (result GetOperationResponse, err error)
  • func (c RecoverableManagedDatabasesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)
  • func (c RecoverableManagedDatabasesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)
  • func (c RecoverableManagedDatabasesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, ...) (result ListByInstanceCompleteResult, err error)

Functions

func ValidateManagedInstanceRecoverableDatabaseID

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

ValidateManagedInstanceRecoverableDatabaseID checks that 'input' can be parsed as a Managed Instance Recoverable Database ID

Types

type GetOperationResponse

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

type ListByInstanceCompleteResult

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

type ListByInstanceCustomPager

type ListByInstanceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByInstanceCustomPager) NextPageLink

func (p *ListByInstanceCustomPager) NextPageLink() *odata.Link

type ListByInstanceOperationResponse

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

type ManagedInstanceRecoverableDatabaseId

type ManagedInstanceRecoverableDatabaseId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ManagedInstanceName     string
	RecoverableDatabaseName string
}

ManagedInstanceRecoverableDatabaseId is a struct representing the Resource ID for a Managed Instance Recoverable Database

func NewManagedInstanceRecoverableDatabaseID

func NewManagedInstanceRecoverableDatabaseID(subscriptionId string, resourceGroupName string, managedInstanceName string, recoverableDatabaseName string) ManagedInstanceRecoverableDatabaseId

NewManagedInstanceRecoverableDatabaseID returns a new ManagedInstanceRecoverableDatabaseId struct

func ParseManagedInstanceRecoverableDatabaseID

func ParseManagedInstanceRecoverableDatabaseID(input string) (*ManagedInstanceRecoverableDatabaseId, error)

ParseManagedInstanceRecoverableDatabaseID parses 'input' into a ManagedInstanceRecoverableDatabaseId

func ParseManagedInstanceRecoverableDatabaseIDInsensitively

func ParseManagedInstanceRecoverableDatabaseIDInsensitively(input string) (*ManagedInstanceRecoverableDatabaseId, error)

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

func (*ManagedInstanceRecoverableDatabaseId) FromParseResult

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

func (ManagedInstanceRecoverableDatabaseId) ID

func (id ManagedInstanceRecoverableDatabaseId) ID() string

ID returns the formatted Managed Instance Recoverable Database ID

func (ManagedInstanceRecoverableDatabaseId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Managed Instance Recoverable Database ID

func (ManagedInstanceRecoverableDatabaseId) String

func (id ManagedInstanceRecoverableDatabaseId) String() string

String returns a human-readable description of this Managed Instance Recoverable Database ID

type RecoverableManagedDatabase

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

type RecoverableManagedDatabaseOperationPredicate

type RecoverableManagedDatabaseOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (RecoverableManagedDatabaseOperationPredicate) Matches

func (p RecoverableManagedDatabaseOperationPredicate) Matches(input RecoverableManagedDatabase) bool

type RecoverableManagedDatabaseProperties

type RecoverableManagedDatabaseProperties struct {
	LastAvailableBackupDate *string `json:"lastAvailableBackupDate,omitempty"`
}

type RecoverableManagedDatabasesClient

type RecoverableManagedDatabasesClient struct {
	Client *resourcemanager.Client
}

func NewRecoverableManagedDatabasesClientWithBaseURI

func NewRecoverableManagedDatabasesClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoverableManagedDatabasesClient, error)

func (RecoverableManagedDatabasesClient) Get

func (c RecoverableManagedDatabasesClient) Get(ctx context.Context, id ManagedInstanceRecoverableDatabaseId) (result GetOperationResponse, err error)

Get ...

func (RecoverableManagedDatabasesClient) ListByInstance

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

ListByInstance ...

func (RecoverableManagedDatabasesClient) ListByInstanceComplete

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

ListByInstanceComplete retrieves all the results into a single object

func (RecoverableManagedDatabasesClient) ListByInstanceCompleteMatchingPredicate

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

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate