backupshorttermretentionpolicies

package
v0.20240606.1065251 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

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

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

Client Initialization

client := backupshorttermretentionpolicies.NewBackupShortTermRetentionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupShortTermRetentionPoliciesClient.CreateOrUpdate

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

payload := backupshorttermretentionpolicies.BackupShortTermRetentionPolicy{
	// ...
}


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

Example Usage: BackupShortTermRetentionPoliciesClient.Get

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "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: BackupShortTermRetentionPoliciesClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "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: BackupShortTermRetentionPoliciesClient.Update

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

payload := backupshorttermretentionpolicies.BackupShortTermRetentionPolicy{
	// ...
}


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 PossibleValuesForDiffBackupIntervalInHours 

func PossibleValuesForDiffBackupIntervalInHours() []int64

Types

type BackupShortTermRetentionPoliciesClient 

type BackupShortTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewBackupShortTermRetentionPoliciesClientWithBaseURI 

func NewBackupShortTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupShortTermRetentionPoliciesClient, error)

func (BackupShortTermRetentionPoliciesClient) CreateOrUpdate 

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

CreateOrUpdate ...

func (BackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll 

func (c BackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input BackupShortTermRetentionPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BackupShortTermRetentionPoliciesClient) Get 

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

Get ...

func (BackupShortTermRetentionPoliciesClient) ListByDatabase 

func (c BackupShortTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (BackupShortTermRetentionPoliciesClient) ListByDatabaseComplete 

func (c BackupShortTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (BackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate 

func (c BackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, predicate BackupShortTermRetentionPolicyOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BackupShortTermRetentionPoliciesClient) Update 

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

Update ...

func (BackupShortTermRetentionPoliciesClient) UpdateThenPoll 

func (c BackupShortTermRetentionPoliciesClient) UpdateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input BackupShortTermRetentionPolicy) error

UpdateThenPoll performs Update then polls until it's completed

type BackupShortTermRetentionPolicy 

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

type BackupShortTermRetentionPolicyOperationPredicate 

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

func (BackupShortTermRetentionPolicyOperationPredicate) Matches 

func (p BackupShortTermRetentionPolicyOperationPredicate) Matches(input BackupShortTermRetentionPolicy) bool

type BackupShortTermRetentionPolicyProperties 

type BackupShortTermRetentionPolicyProperties struct {
	DiffBackupIntervalInHours *DiffBackupIntervalInHours `json:"diffBackupIntervalInHours,omitempty"`
	RetentionDays             *int64                     `json:"retentionDays,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DiffBackupIntervalInHours 

type DiffBackupIntervalInHours int64
const (
	DiffBackupIntervalInHoursOneTwo  DiffBackupIntervalInHours = 12
	DiffBackupIntervalInHoursTwoFour DiffBackupIntervalInHours = 24
)

type GetOperationResponse 

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

type ListByDatabaseCompleteResult 

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BackupShortTermRetentionPolicy
}

type ListByDatabaseOperationResponse 

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

type UpdateOperationResponse 

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

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.