geobackuppolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/geobackuppolicies Documentation

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

Client Initialization

client := geobackuppolicies.NewGeoBackupPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GeoBackupPoliciesClient.CreateOrUpdate

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

payload := geobackuppolicies.GeoBackupPolicy{
	// ...
}


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

Example Usage: GeoBackupPoliciesClient.Get

ctx := context.TODO()
id := geobackuppolicies.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: GeoBackupPoliciesClient.List

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

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

Documentation

Index

• func PossibleValuesForGeoBackupPolicyState() []string
• func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• 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 GeoBackupPoliciesClient
  • func NewGeoBackupPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*GeoBackupPoliciesClient, error)
  • func (c GeoBackupPoliciesClient) CreateOrUpdate(ctx context.Context, id DatabaseId, input GeoBackupPolicy) (result CreateOrUpdateOperationResponse, err error)
  • func (c GeoBackupPoliciesClient) Get(ctx context.Context, id DatabaseId) (result GetOperationResponse, err error)
  • func (c GeoBackupPoliciesClient) List(ctx context.Context, id DatabaseId) (result ListOperationResponse, err error)
  • func (c GeoBackupPoliciesClient) ListComplete(ctx context.Context, id DatabaseId) (ListCompleteResult, error)
  • func (c GeoBackupPoliciesClient) ListCompleteMatchingPredicate(ctx context.Context, id DatabaseId, ...) (result ListCompleteResult, err error)
• type GeoBackupPolicy
• type GeoBackupPolicyOperationPredicate
  • func (p GeoBackupPolicyOperationPredicate) Matches(input GeoBackupPolicy) bool
• type GeoBackupPolicyProperties
• type GeoBackupPolicyState
  • func (s *GeoBackupPolicyState) UnmarshalJSON(bytes []byte) error
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse

Functions

func PossibleValuesForGeoBackupPolicyState

func PossibleValuesForGeoBackupPolicyState() []string

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 CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GeoBackupPolicy
}

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 GeoBackupPoliciesClient

type GeoBackupPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewGeoBackupPoliciesClientWithBaseURI

func NewGeoBackupPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*GeoBackupPoliciesClient, error)

func (GeoBackupPoliciesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (GeoBackupPoliciesClient) Get

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

Get ...

func (GeoBackupPoliciesClient) List

func (c GeoBackupPoliciesClient) List(ctx context.Context, id DatabaseId) (result ListOperationResponse, err error)

List ...

func (GeoBackupPoliciesClient) ListComplete

func (c GeoBackupPoliciesClient) ListComplete(ctx context.Context, id DatabaseId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (GeoBackupPoliciesClient) ListCompleteMatchingPredicate

func (c GeoBackupPoliciesClient) ListCompleteMatchingPredicate(ctx context.Context, id DatabaseId, predicate GeoBackupPolicyOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GeoBackupPolicy

type GeoBackupPolicy struct {
	Id         *string                    `json:"id,omitempty"`
	Kind       *string                    `json:"kind,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *GeoBackupPolicyProperties `json:"properties,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type GeoBackupPolicyOperationPredicate

type GeoBackupPolicyOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (GeoBackupPolicyOperationPredicate) Matches

func (p GeoBackupPolicyOperationPredicate) Matches(input GeoBackupPolicy) bool

type GeoBackupPolicyProperties

type GeoBackupPolicyProperties struct {
	State       GeoBackupPolicyState `json:"state"`
	StorageType *string              `json:"storageType,omitempty"`
}

type GeoBackupPolicyState

type GeoBackupPolicyState string

const (
	GeoBackupPolicyStateDisabled GeoBackupPolicyState = "Disabled"
	GeoBackupPolicyStateEnabled  GeoBackupPolicyState = "Enabled"
)

func (*GeoBackupPolicyState) UnmarshalJSON

func (s *GeoBackupPolicyState) UnmarshalJSON(bytes []byte) error

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []GeoBackupPolicy
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GeoBackupPolicy
}