managedbackupshorttermretentionpolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/managedbackupshorttermretentionpolicies Documentation

The managedbackupshorttermretentionpolicies SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2022-11-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-sdk/resource-manager/sql/2022-11-01-preview/managedbackupshorttermretentionpolicies"

Client Initialization

client := managedbackupshorttermretentionpolicies.NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedBackupShortTermRetentionPoliciesClient.CreateOrUpdate

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

payload := managedbackupshorttermretentionpolicies.ManagedBackupShortTermRetentionPolicy{
	// ...
}


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

Example Usage: ManagedBackupShortTermRetentionPoliciesClient.Get

ctx := context.TODO()
id := managedbackupshorttermretentionpolicies.NewManagedInstanceDatabaseID("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: ManagedBackupShortTermRetentionPoliciesClient.ListByDatabase

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

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

Example Usage: ManagedBackupShortTermRetentionPoliciesClient.Update

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

payload := managedbackupshorttermretentionpolicies.ManagedBackupShortTermRetentionPolicy{
	// ...
}


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

Documentation

Index

• func ValidateManagedInstanceDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationResponse
• type ManagedBackupShortTermRetentionPoliciesClient
  • func NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedBackupShortTermRetentionPoliciesClient, error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceDatabaseId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceDatabaseId, ...) error
  • func (c ManagedBackupShortTermRetentionPoliciesClient) Get(ctx context.Context, id ManagedInstanceDatabaseId) (result GetOperationResponse, err error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id ManagedInstanceDatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id ManagedInstanceDatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id ManagedInstanceDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) Update(ctx context.Context, id ManagedInstanceDatabaseId, ...) (result UpdateOperationResponse, err error)
  • func (c ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll(ctx context.Context, id ManagedInstanceDatabaseId, ...) error
• type ManagedBackupShortTermRetentionPolicy
• type ManagedBackupShortTermRetentionPolicyOperationPredicate
  • func (p ManagedBackupShortTermRetentionPolicyOperationPredicate) Matches(input ManagedBackupShortTermRetentionPolicy) bool
• type ManagedBackupShortTermRetentionPolicyProperties
• type ManagedInstanceDatabaseId
  • func NewManagedInstanceDatabaseID(subscriptionId string, resourceGroupName string, managedInstanceName string, ...) ManagedInstanceDatabaseId
  • func ParseManagedInstanceDatabaseID(input string) (*ManagedInstanceDatabaseId, error)
  • func ParseManagedInstanceDatabaseIDInsensitively(input string) (*ManagedInstanceDatabaseId, error)
  • func (id ManagedInstanceDatabaseId) ID() string
  • func (id ManagedInstanceDatabaseId) Segments() []resourceids.Segment
  • func (id ManagedInstanceDatabaseId) String() string
• type UpdateOperationResponse

Functions

func ValidateManagedInstanceDatabaseID

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

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

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	Items []ManagedBackupShortTermRetentionPolicy
}

type ListByDatabaseOperationResponse

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedBackupShortTermRetentionPolicy
}

type ManagedBackupShortTermRetentionPoliciesClient

type ManagedBackupShortTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI

func NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedBackupShortTermRetentionPoliciesClient, error)

func (ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdate

func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id ManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll

func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedBackupShortTermRetentionPoliciesClient) Get

func (c ManagedBackupShortTermRetentionPoliciesClient) Get(ctx context.Context, id ManagedInstanceDatabaseId) (result GetOperationResponse, err error)

Get ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabase

func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id ManagedInstanceDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete

func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id ManagedInstanceDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id ManagedInstanceDatabaseId, predicate ManagedBackupShortTermRetentionPolicyOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedBackupShortTermRetentionPoliciesClient) Update

func (c ManagedBackupShortTermRetentionPoliciesClient) Update(ctx context.Context, id ManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) (result UpdateOperationResponse, err error)

Update ...

func (ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll

func (c ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll(ctx context.Context, id ManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) error

UpdateThenPoll performs Update then polls until it's completed

type ManagedBackupShortTermRetentionPolicy

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

type ManagedBackupShortTermRetentionPolicyOperationPredicate

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

func (ManagedBackupShortTermRetentionPolicyOperationPredicate) Matches

func (p ManagedBackupShortTermRetentionPolicyOperationPredicate) Matches(input ManagedBackupShortTermRetentionPolicy) bool

type ManagedBackupShortTermRetentionPolicyProperties

type ManagedBackupShortTermRetentionPolicyProperties struct {
	RetentionDays *int64 `json:"retentionDays,omitempty"`
}

type ManagedInstanceDatabaseId

type ManagedInstanceDatabaseId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DatabaseName        string
}

ManagedInstanceDatabaseId is a struct representing the Resource ID for a Managed Instance Database

func NewManagedInstanceDatabaseID

func NewManagedInstanceDatabaseID(subscriptionId string, resourceGroupName string, managedInstanceName string, databaseName string) ManagedInstanceDatabaseId

NewManagedInstanceDatabaseID returns a new ManagedInstanceDatabaseId struct

func ParseManagedInstanceDatabaseID

func ParseManagedInstanceDatabaseID(input string) (*ManagedInstanceDatabaseId, error)

ParseManagedInstanceDatabaseID parses 'input' into a ManagedInstanceDatabaseId

func ParseManagedInstanceDatabaseIDInsensitively

func ParseManagedInstanceDatabaseIDInsensitively(input string) (*ManagedInstanceDatabaseId, error)

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

func (ManagedInstanceDatabaseId) ID

func (id ManagedInstanceDatabaseId) ID() string

ID returns the formatted Managed Instance Database ID

func (ManagedInstanceDatabaseId) Segments

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

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

func (ManagedInstanceDatabaseId) String

func (id ManagedInstanceDatabaseId) String() string

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

type UpdateOperationResponse

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