sqlpoolsgeobackuppolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsgeobackuppolicies Documentation

The sqlpoolsgeobackuppolicies SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-01).

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/synapse/2021-06-01/sqlpoolsgeobackuppolicies"

Client Initialization

client := sqlpoolsgeobackuppolicies.NewSqlPoolsGeoBackupPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsGeoBackupPoliciesClient.SqlPoolGeoBackupPoliciesCreateOrUpdate

ctx := context.TODO()
id := sqlpoolsgeobackuppolicies.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

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


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

Example Usage: SqlPoolsGeoBackupPoliciesClient.SqlPoolGeoBackupPoliciesGet

ctx := context.TODO()
id := sqlpoolsgeobackuppolicies.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

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

Example Usage: SqlPoolsGeoBackupPoliciesClient.SqlPoolGeoBackupPoliciesList

ctx := context.TODO()
id := sqlpoolsgeobackuppolicies.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

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

Documentation

Index

• func PossibleValuesForGeoBackupPolicyState() []string
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type GeoBackupPolicy
• type GeoBackupPolicyListResult
• type GeoBackupPolicyProperties
• type GeoBackupPolicyState
  • func (s *GeoBackupPolicyState) UnmarshalJSON(bytes []byte) error
• type SqlPoolGeoBackupPoliciesCreateOrUpdateOperationResponse
• type SqlPoolGeoBackupPoliciesGetOperationResponse
• type SqlPoolGeoBackupPoliciesListOperationResponse
• type SqlPoolId
  • func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, ...) SqlPoolId
  • func ParseSqlPoolID(input string) (*SqlPoolId, error)
  • func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)
  • func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id SqlPoolId) ID() string
  • func (id SqlPoolId) Segments() []resourceids.Segment
  • func (id SqlPoolId) String() string
• type SqlPoolsGeoBackupPoliciesClient
  • func NewSqlPoolsGeoBackupPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsGeoBackupPoliciesClient, error)
  • func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesCreateOrUpdate(ctx context.Context, id SqlPoolId, input GeoBackupPolicy) (result SqlPoolGeoBackupPoliciesCreateOrUpdateOperationResponse, err error)
  • func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesGet(ctx context.Context, id SqlPoolId) (result SqlPoolGeoBackupPoliciesGetOperationResponse, err error)
  • func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesList(ctx context.Context, id SqlPoolId) (result SqlPoolGeoBackupPoliciesListOperationResponse, err error)

Functions

func PossibleValuesForGeoBackupPolicyState

func PossibleValuesForGeoBackupPolicyState() []string

func ValidateSqlPoolID

func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)

ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID

Types

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"`
	Type       *string                   `json:"type,omitempty"`
}

type GeoBackupPolicyListResult

type GeoBackupPolicyListResult struct {
	Value *[]GeoBackupPolicy `json:"value,omitempty"`
}

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 SqlPoolGeoBackupPoliciesCreateOrUpdateOperationResponse

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

type SqlPoolGeoBackupPoliciesGetOperationResponse

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

type SqlPoolGeoBackupPoliciesListOperationResponse

type SqlPoolGeoBackupPoliciesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GeoBackupPolicyListResult
}

type SqlPoolId

type SqlPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
}

SqlPoolId is a struct representing the Resource ID for a Sql Pool

func NewSqlPoolID

func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string) SqlPoolId

NewSqlPoolID returns a new SqlPoolId struct

func ParseSqlPoolID

func ParseSqlPoolID(input string) (*SqlPoolId, error)

ParseSqlPoolID parses 'input' into a SqlPoolId

func ParseSqlPoolIDInsensitively

func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)

ParseSqlPoolIDInsensitively parses 'input' case-insensitively into a SqlPoolId note: this method should only be used for API response data and not user input

func (*SqlPoolId) FromParseResult

func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error

func (SqlPoolId) ID

func (id SqlPoolId) ID() string

ID returns the formatted Sql Pool ID

func (SqlPoolId) Segments

func (id SqlPoolId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Sql Pool ID

func (SqlPoolId) String

func (id SqlPoolId) String() string

String returns a human-readable description of this Sql Pool ID

type SqlPoolsGeoBackupPoliciesClient

type SqlPoolsGeoBackupPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsGeoBackupPoliciesClientWithBaseURI

func NewSqlPoolsGeoBackupPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsGeoBackupPoliciesClient, error)

func (SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesCreateOrUpdate

func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesCreateOrUpdate(ctx context.Context, id SqlPoolId, input GeoBackupPolicy) (result SqlPoolGeoBackupPoliciesCreateOrUpdateOperationResponse, err error)

SqlPoolGeoBackupPoliciesCreateOrUpdate ...

func (SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesGet

func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesGet(ctx context.Context, id SqlPoolId) (result SqlPoolGeoBackupPoliciesGetOperationResponse, err error)

SqlPoolGeoBackupPoliciesGet ...

func (SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesList

func (c SqlPoolsGeoBackupPoliciesClient) SqlPoolGeoBackupPoliciesList(ctx context.Context, id SqlPoolId) (result SqlPoolGeoBackupPoliciesListOperationResponse, err error)

SqlPoolGeoBackupPoliciesList ...