virtualendpoints

package
v0.20240527.1094340 Latest Latest
Warning

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

 Go to latest Published: May 27, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

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

Client Initialization

client := virtualendpoints.NewVirtualEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualEndpointsClient.Create

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

payload := virtualendpoints.VirtualEndpointResource{
	// ...
}


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

Example Usage: VirtualEndpointsClient.Delete

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

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

Example Usage: VirtualEndpointsClient.Get

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

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: VirtualEndpointsClient.ListByServer

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

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

Example Usage: VirtualEndpointsClient.Update

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

payload := virtualendpoints.VirtualEndpointResourceForPatch{
	// ...
}


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

func PossibleValuesForVirtualEndpointType 

func PossibleValuesForVirtualEndpointType() []string

func ValidateFlexibleServerID 

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID

func ValidateVirtualEndpointID 

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

ValidateVirtualEndpointID checks that 'input' can be parsed as a Virtual Endpoint ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualEndpointResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type FlexibleServerId 

type FlexibleServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID 

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID 

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively 

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (*FlexibleServerId) FromParseResult 

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

func (FlexibleServerId) ID 

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Flexible Server ID

func (FlexibleServerId) String 

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type GetOperationResponse 

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

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VirtualEndpointResource
}

type ListByServerOperationResponse 

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VirtualEndpointResource
}

type UpdateOperationResponse 

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

type VirtualEndpointId 

type VirtualEndpointId struct {
	SubscriptionId      string
	ResourceGroupName   string
	FlexibleServerName  string
	VirtualEndpointName string
}

VirtualEndpointId is a struct representing the Resource ID for a Virtual Endpoint

func NewVirtualEndpointID 

func NewVirtualEndpointID(subscriptionId string, resourceGroupName string, flexibleServerName string, virtualEndpointName string) VirtualEndpointId

NewVirtualEndpointID returns a new VirtualEndpointId struct

func ParseVirtualEndpointID 

func ParseVirtualEndpointID(input string) (*VirtualEndpointId, error)

ParseVirtualEndpointID parses 'input' into a VirtualEndpointId

func ParseVirtualEndpointIDInsensitively 

func ParseVirtualEndpointIDInsensitively(input string) (*VirtualEndpointId, error)

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

func (*VirtualEndpointId) FromParseResult 

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

func (VirtualEndpointId) ID 

func (id VirtualEndpointId) ID() string

ID returns the formatted Virtual Endpoint ID

func (VirtualEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Endpoint ID

func (VirtualEndpointId) String 

func (id VirtualEndpointId) String() string

String returns a human-readable description of this Virtual Endpoint ID

type VirtualEndpointResource 

type VirtualEndpointResource struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *VirtualEndpointResourceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type VirtualEndpointResourceForPatch 

type VirtualEndpointResourceForPatch struct {
	Properties *VirtualEndpointResourceProperties `json:"properties,omitempty"`
}

type VirtualEndpointResourceOperationPredicate 

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

func (VirtualEndpointResourceOperationPredicate) Matches 

func (p VirtualEndpointResourceOperationPredicate) Matches(input VirtualEndpointResource) bool

type VirtualEndpointResourceProperties 

type VirtualEndpointResourceProperties struct {
	EndpointType     *VirtualEndpointType `json:"endpointType,omitempty"`
	Members          *[]string            `json:"members,omitempty"`
	VirtualEndpoints *[]string            `json:"virtualEndpoints,omitempty"`
}

type VirtualEndpointType 

type VirtualEndpointType string
const (
	VirtualEndpointTypeReadWrite VirtualEndpointType = "ReadWrite"
)

func (*VirtualEndpointType) UnmarshalJSON 

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

type VirtualEndpointsClient 

type VirtualEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewVirtualEndpointsClientWithBaseURI 

func NewVirtualEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualEndpointsClient, error)

func (VirtualEndpointsClient) Create 

func (c VirtualEndpointsClient) Create(ctx context.Context, id VirtualEndpointId, input VirtualEndpointResource) (result CreateOperationResponse, err error)

Create ...

func (VirtualEndpointsClient) CreateThenPoll 

func (c VirtualEndpointsClient) CreateThenPoll(ctx context.Context, id VirtualEndpointId, input VirtualEndpointResource) error

CreateThenPoll performs Create then polls until it's completed

func (VirtualEndpointsClient) Delete 

func (c VirtualEndpointsClient) Delete(ctx context.Context, id VirtualEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualEndpointsClient) DeleteThenPoll 

func (c VirtualEndpointsClient) DeleteThenPoll(ctx context.Context, id VirtualEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualEndpointsClient) Get 

func (c VirtualEndpointsClient) Get(ctx context.Context, id VirtualEndpointId) (result GetOperationResponse, err error)

Get ...

func (VirtualEndpointsClient) ListByServer 

func (c VirtualEndpointsClient) ListByServer(ctx context.Context, id FlexibleServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (VirtualEndpointsClient) ListByServerComplete 

func (c VirtualEndpointsClient) ListByServerComplete(ctx context.Context, id FlexibleServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (VirtualEndpointsClient) ListByServerCompleteMatchingPredicate 

func (c VirtualEndpointsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, predicate VirtualEndpointResourceOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (VirtualEndpointsClient) Update 

func (c VirtualEndpointsClient) Update(ctx context.Context, id VirtualEndpointId, input VirtualEndpointResourceForPatch) (result UpdateOperationResponse, err error)

Update ...

func (VirtualEndpointsClient) UpdateThenPoll 

func (c VirtualEndpointsClient) UpdateThenPoll(ctx context.Context, id VirtualEndpointId, input VirtualEndpointResourceForPatch) error

UpdateThenPoll performs Update then polls until it's completed

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.