backupshorttermretentionpolicies

package
v0.20240715.1103416 Latest Latest
Warning

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

Go to latest
Published: Jul 15, 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

CreateOrUpdate ...

func (BackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BackupShortTermRetentionPoliciesClient) Get

Get ...

func (BackupShortTermRetentionPoliciesClient) ListByDatabase

ListByDatabase ...

func (BackupShortTermRetentionPoliciesClient) ListByDatabaseComplete

ListByDatabaseComplete retrieves all the results into a single object

func (BackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BackupShortTermRetentionPoliciesClient) Update

Update ...

func (BackupShortTermRetentionPoliciesClient) UpdateThenPoll

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

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 ListByDatabaseCustomPager added in v0.20240628.1153531

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

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL