longtermretentionpolicies

package
v0.20240923.1142107 Latest Latest
Warning

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

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

README

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

The longtermretentionpolicies SDK allows for interaction with Azure Resource Manager 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", "serverName", "databaseName")

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", "serverName", "databaseName")

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", "serverName", "databaseName")

// 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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 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        *[]LongTermRetentionPolicy
}

type LongTermRetentionPoliciesClient

type LongTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewLongTermRetentionPoliciesClientWithBaseURI

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

func (LongTermRetentionPoliciesClient) CreateOrUpdate

CreateOrUpdate ...

func (LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (LongTermRetentionPoliciesClient) Get

Get ...

func (LongTermRetentionPoliciesClient) ListByDatabase

ListByDatabase ...

func (LongTermRetentionPoliciesClient) ListByDatabaseComplete

ListByDatabaseComplete retrieves all the results into a single object

func (LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

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

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"`
}

Jump to

Keyboard shortcuts

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