backuplongtermretentionpolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2017-03-01-preview/backuplongtermretentionpolicies Documentation

The backuplongtermretentionpolicies SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2017-03-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/2017-03-01-preview/backuplongtermretentionpolicies"

Client Initialization

client := backuplongtermretentionpolicies.NewBackupLongTermRetentionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupLongTermRetentionPoliciesClient.CreateOrUpdate

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

payload := backuplongtermretentionpolicies.BackupLongTermRetentionPolicy{
	// ...
}


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

Example Usage: BackupLongTermRetentionPoliciesClient.Get

ctx := context.TODO()
id := backuplongtermretentionpolicies.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: BackupLongTermRetentionPoliciesClient.ListByDatabase

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

read, err := client.ListByDatabase(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type BackupLongTermRetentionPoliciesClient
  • func NewBackupLongTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupLongTermRetentionPoliciesClient, error)
  • func (c BackupLongTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id DatabaseId, input BackupLongTermRetentionPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c BackupLongTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id DatabaseId, input BackupLongTermRetentionPolicy) error
  • func (c BackupLongTermRetentionPoliciesClient) Get(ctx context.Context, id DatabaseId) (result GetOperationResponse, err error)
  • func (c BackupLongTermRetentionPoliciesClient) ListByDatabase(ctx context.Context, id DatabaseId) (result ListByDatabaseOperationResponse, err error)
• type BackupLongTermRetentionPolicy
• 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 ListByDatabaseOperationResponse
• type LongTermRetentionPolicyProperties

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 BackupLongTermRetentionPoliciesClient

type BackupLongTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewBackupLongTermRetentionPoliciesClientWithBaseURI

func NewBackupLongTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupLongTermRetentionPoliciesClient, error)

func (BackupLongTermRetentionPoliciesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (BackupLongTermRetentionPoliciesClient) CreateOrUpdateThenPoll

func (c BackupLongTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id DatabaseId, input BackupLongTermRetentionPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BackupLongTermRetentionPoliciesClient) Get

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

Get ...

func (BackupLongTermRetentionPoliciesClient) ListByDatabase

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

ListByDatabase ...

type BackupLongTermRetentionPolicy

type BackupLongTermRetentionPolicy struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *LongTermRetentionPolicyProperties `json:"properties,omitempty"`
	Type       *string                            `json:"type,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        *BackupLongTermRetentionPolicy
}

type ListByDatabaseOperationResponse

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BackupLongTermRetentionPolicy
}

type LongTermRetentionPolicyProperties

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