package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2023-06-01-preview/longtermretentionbackup Documentation

The longtermretentionbackup SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2023-06-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/postgresql/2023-06-01-preview/longtermretentionbackup"

Client Initialization

client := longtermretentionbackup.NewLongTermRetentionBackupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LongTermRetentionBackupClient.FlexibleServerStartLtrBackup

ctx := context.TODO()
id := longtermretentionbackup.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

payload := longtermretentionbackup.LtrBackupRequest{
	// ...
}


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

Example Usage: LongTermRetentionBackupClient.FlexibleServerTriggerLtrPreBackup

ctx := context.TODO()
id := longtermretentionbackup.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

payload := longtermretentionbackup.BackupRequestBase{
	// ...
}


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

Example Usage: LongTermRetentionBackupClient.LtrBackupOperationsGet

ctx := context.TODO()
id := longtermretentionbackup.NewLtrBackupOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "ltrBackupOperationValue")

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

Example Usage: LongTermRetentionBackupClient.LtrBackupOperationsListByServer

ctx := context.TODO()
id := longtermretentionbackup.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

// alternatively `client.LtrBackupOperationsListByServer(ctx, id)` can be used to do batched pagination
items, err := client.LtrBackupOperationsListByServerComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

# Functions

NewFlexibleServerID returns a new FlexibleServerId struct.
No description provided by the author
NewLtrBackupOperationID returns a new LtrBackupOperationId struct.
ParseFlexibleServerID parses 'input' into a FlexibleServerId.
ParseFlexibleServerIDInsensitively parses 'input' case-insensitively into a FlexibleServerId note: this method should only be used for API response data and not user input.
ParseLtrBackupOperationID parses 'input' into a LtrBackupOperationId.
ParseLtrBackupOperationIDInsensitively parses 'input' case-insensitively into a LtrBackupOperationId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID.
ValidateLtrBackupOperationID checks that 'input' can be parsed as a Ltr Backup Operation ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
FlexibleServerId is a struct representing the Resource ID for a Flexible Server.
No description provided by the author
No description provided by the author
No description provided by the author
LtrBackupOperationId is a struct representing the Resource ID for a Ltr Backup Operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author