managedbackupshorttermretentionpolicies

package
v0.20240625.1123713 Latest Latest
Warning

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

Go to latest
Published: Jun 25, 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 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

CreateOrUpdate ...

func (ManagedBackupShortTermRetentionPoliciesClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedBackupShortTermRetentionPoliciesClient) Get

Get ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabase

ListByDatabase ...

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseComplete

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedBackupShortTermRetentionPoliciesClient) ListByDatabaseCompleteMatchingPredicate

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedBackupShortTermRetentionPoliciesClient) Update

Update ...

func (ManagedBackupShortTermRetentionPoliciesClient) UpdateThenPoll

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

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
}

Jump to

Keyboard shortcuts

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