longtermretentionpolicies

README

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

The longtermretentionpolicies SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2021-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-sdk/resource-manager/sql/2021-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 := longtermretentionpolicies.NewDatabaseID("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 := longtermretentionpolicies.NewDatabaseID("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 := longtermretentionpolicies.NewDatabaseID("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

• func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type BaseLongTermRetentionPolicyProperties
• type CreateOrUpdateOperationResponse
• type DatabaseId
  • func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, ...) DatabaseId
  • func ParseDatabaseID(input string) (*DatabaseId, error)
  • func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)
  • func (id DatabaseId) ID() string
  • func (id DatabaseId) Segments() []resourceids.Segment
  • func (id DatabaseId) String() string
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationResponse
• type LongTermRetentionPoliciesClient
  • func NewLongTermRetentionPoliciesClientWithBaseURI(api environments.Api) (*LongTermRetentionPoliciesClient, error)
  • func (c LongTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id DatabaseId, input LongTermRetentionPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id DatabaseId, input LongTermRetentionPolicy) error
  • func (c LongTermRetentionPoliciesClient) Get(ctx context.Context, id DatabaseId) (result GetOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id DatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id DatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id DatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
• type LongTermRetentionPolicy
• type LongTermRetentionPolicyOperationPredicate
  • func (p LongTermRetentionPolicyOperationPredicate) Matches(input LongTermRetentionPolicy) bool

Functions

func ValidateDatabaseID

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

ValidateDatabaseID checks that 'input' can be parsed as a Database ID

Types

type BaseLongTermRetentionPolicyProperties

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

type CreateOrUpdateOperationResponse

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

type DatabaseId

type DatabaseId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
}

DatabaseId is a struct representing the Resource ID for a Database

func NewDatabaseID

func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, databaseName string) DatabaseId

NewDatabaseID returns a new DatabaseId struct

func ParseDatabaseID

func ParseDatabaseID(input string) (*DatabaseId, error)

ParseDatabaseID parses 'input' into a DatabaseId

func ParseDatabaseIDInsensitively

func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)

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

func (DatabaseId) ID

func (id DatabaseId) ID() string

ID returns the formatted Database ID

func (DatabaseId) Segments

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

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

func (DatabaseId) String

func (id DatabaseId) String() string

String returns a human-readable description of this Database ID

type GetOperationResponse

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

type ListByDatabaseCompleteResult

type ListByDatabaseCompleteResult struct {
	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(api environments.Api) (*LongTermRetentionPoliciesClient, error)

func (LongTermRetentionPoliciesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (LongTermRetentionPoliciesClient) CreateOrUpdateThenPoll

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

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (LongTermRetentionPoliciesClient) Get

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

Get ...

func (LongTermRetentionPoliciesClient) ListByDatabase

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

ListByDatabase ...

func (LongTermRetentionPoliciesClient) ListByDatabaseComplete

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

ListByDatabaseComplete retrieves all the results into a single object

func (LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

func (c LongTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id DatabaseId, 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 *BaseLongTermRetentionPolicyProperties `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