longtermretentionpolicies

README

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

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

Client Initialization

client := longtermretentionpolicies.NewLongTermRetentionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LongTermRetentionPoliciesClient.CreateOrUpdate

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

payload := longtermretentionpolicies.LongTermRetentionPolicy{
	// ...
}


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

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

Documentation

Index

• type CreateOrUpdateOperationResponse
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationResponse
• type LongTermRetentionPoliciesClient
  • func NewLongTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*LongTermRetentionPoliciesClient, error)
  • func (c LongTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlDatabaseId, input LongTermRetentionPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input LongTermRetentionPolicy) error
  • func (c LongTermRetentionPoliciesClient) Get(ctx context.Context, id commonids.SqlDatabaseId) (result GetOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
• type LongTermRetentionPolicy
• type LongTermRetentionPolicyOperationPredicate
  • func (p LongTermRetentionPolicyOperationPredicate) Matches(input LongTermRetentionPolicy) bool
• type LongTermRetentionPolicyProperties

Types

type CreateOrUpdateOperationResponse

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

type GetOperationResponse

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

type ListByDatabaseCompleteResult

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

type ListByDatabaseOperationResponse

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

type LongTermRetentionPoliciesClient

type LongTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewLongTermRetentionPoliciesClientWithBaseURI

func NewLongTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*LongTermRetentionPoliciesClient, error)

func (LongTermRetentionPoliciesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll

func (c LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input LongTermRetentionPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (LongTermRetentionPoliciesClient) Get

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

Get ...

func (LongTermRetentionPoliciesClient) ListByDatabase

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

ListByDatabase ...

func (LongTermRetentionPoliciesClient) ListByDatabaseComplete

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

ListByDatabaseComplete retrieves all the results into a single object

func (LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

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

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LongTermRetentionPolicy

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

type LongTermRetentionPolicyOperationPredicate

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

func (LongTermRetentionPolicyOperationPredicate) Matches

func (p LongTermRetentionPolicyOperationPredicate) Matches(input LongTermRetentionPolicy) bool

type LongTermRetentionPolicyProperties

type LongTermRetentionPolicyProperties struct {
	MakeBackupsImmutable *bool   `json:"makeBackupsImmutable,omitempty"`
	MonthlyRetention     *string `json:"monthlyRetention,omitempty"`
	WeekOfYear           *int64  `json:"weekOfYear,omitempty"`
	WeeklyRetention      *string `json:"weeklyRetention,omitempty"`
	YearlyRetention      *string `json:"yearlyRetention,omitempty"`
}