managedbackupshorttermretentionpolicies

package
v0.20240731.1212841 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := managedbackupshorttermretentionpolicies.NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedBackupShortTermRetentionPoliciesClient.CreateOrUpdate

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

payload := managedbackupshorttermretentionpolicies.ManagedBackupShortTermRetentionPolicy{
	// ...
}


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

Example Usage: ManagedBackupShortTermRetentionPoliciesClient.Get

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedBackupShortTermRetentionPoliciesClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlManagedInstanceDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedBackupShortTermRetentionPoliciesClient.Update

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

payload := managedbackupshorttermretentionpolicies.ManagedBackupShortTermRetentionPolicy{
	// ...
}


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

This section is empty.

Types

type CreateOrUpdateOperationResponse 

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

type GetOperationResponse 

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

type ListByDatabaseCompleteResult 

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

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

type ManagedBackupShortTermRetentionPoliciesClient 

type ManagedBackupShortTermRetentionPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI 

func NewManagedBackupShortTermRetentionPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedBackupShortTermRetentionPoliciesClient, error)

func (ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdate 

func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll 

func (c ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedBackupShortTermRetentionPoliciesClient) Get 

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

Get ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabase 

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

ListByDatabase ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete 

func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate 

func (c ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, predicate ManagedBackupShortTermRetentionPolicyOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedBackupShortTermRetentionPoliciesClient) Update 

func (c ManagedBackupShortTermRetentionPoliciesClient) Update(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) (result UpdateOperationResponse, err error)

Update ...

func (ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll 

func (c ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, input ManagedBackupShortTermRetentionPolicy) error

UpdateThenPoll performs Update then polls until it's completed

type ManagedBackupShortTermRetentionPolicy 

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

type ManagedBackupShortTermRetentionPolicyOperationPredicate 

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

func (ManagedBackupShortTermRetentionPolicyOperationPredicate) Matches 

func (p ManagedBackupShortTermRetentionPolicyOperationPredicate) Matches(input ManagedBackupShortTermRetentionPolicy) bool

type ManagedBackupShortTermRetentionPolicyProperties 

type ManagedBackupShortTermRetentionPolicyProperties struct {
	RetentionDays *int64 `json:"retentionDays,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedBackupShortTermRetentionPolicy
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.