virtualnetworkrules

package
v0.20230216.1112535 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2017-12-01/virtualnetworkrules Documentation

The virtualnetworkrules SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2017-12-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/postgresql/2017-12-01/virtualnetworkrules"

Client Initialization

client := virtualnetworkrules.NewVirtualNetworkRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualNetworkRulesClient.CreateOrUpdate

ctx := context.TODO()
id := virtualnetworkrules.NewVirtualNetworkRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "virtualNetworkRuleValue")

payload := virtualnetworkrules.VirtualNetworkRule{
	// ...
}


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

Example Usage: VirtualNetworkRulesClient.Delete

ctx := context.TODO()
id := virtualnetworkrules.NewVirtualNetworkRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "virtualNetworkRuleValue")

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

Example Usage: VirtualNetworkRulesClient.Get

ctx := context.TODO()
id := virtualnetworkrules.NewVirtualNetworkRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "virtualNetworkRuleValue")

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

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

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForVirtualNetworkRuleState 

func PossibleValuesForVirtualNetworkRuleState() []string

func ValidateServerID 

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

ValidateServerID checks that 'input' can be parsed as a Server ID

func ValidateVirtualNetworkRuleID 

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

ValidateVirtualNetworkRuleID checks that 'input' can be parsed as a Virtual Network Rule ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *VirtualNetworkRule
}

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	Items []VirtualNetworkRule
}

type ListByServerOperationResponse 

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]VirtualNetworkRule
	// contains filtered or unexported fields
}

func (ListByServerOperationResponse) HasMore 

func (r ListByServerOperationResponse) HasMore() bool

func (ListByServerOperationResponse) LoadMore 

func (r ListByServerOperationResponse) LoadMore(ctx context.Context) (resp ListByServerOperationResponse, err error)

type ServerId 

type ServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID 

func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId

NewServerID returns a new ServerId struct

func ParseServerID 

func ParseServerID(input string) (*ServerId, error)

ParseServerID parses 'input' into a ServerId

func ParseServerIDInsensitively 

func ParseServerIDInsensitively(input string) (*ServerId, error)

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

func (ServerId) ID 

func (id ServerId) ID() string

ID returns the formatted Server ID

func (ServerId) Segments 

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

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

func (ServerId) String 

func (id ServerId) String() string

String returns a human-readable description of this Server ID

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *VirtualNetworkRuleProperties `json:"properties,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type VirtualNetworkRuleId 

type VirtualNetworkRuleId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ServerName             string
	VirtualNetworkRuleName string
}

VirtualNetworkRuleId is a struct representing the Resource ID for a Virtual Network Rule

func NewVirtualNetworkRuleID 

func NewVirtualNetworkRuleID(subscriptionId string, resourceGroupName string, serverName string, virtualNetworkRuleName string) VirtualNetworkRuleId

NewVirtualNetworkRuleID returns a new VirtualNetworkRuleId struct

func ParseVirtualNetworkRuleID 

func ParseVirtualNetworkRuleID(input string) (*VirtualNetworkRuleId, error)

ParseVirtualNetworkRuleID parses 'input' into a VirtualNetworkRuleId

func ParseVirtualNetworkRuleIDInsensitively 

func ParseVirtualNetworkRuleIDInsensitively(input string) (*VirtualNetworkRuleId, error)

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

func (VirtualNetworkRuleId) ID 

func (id VirtualNetworkRuleId) ID() string

ID returns the formatted Virtual Network Rule ID

func (VirtualNetworkRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Virtual Network Rule ID

func (VirtualNetworkRuleId) String 

func (id VirtualNetworkRuleId) String() string

String returns a human-readable description of this Virtual Network Rule ID

type VirtualNetworkRuleOperationPredicate 

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

func (VirtualNetworkRuleOperationPredicate) Matches 

func (p VirtualNetworkRuleOperationPredicate) Matches(input VirtualNetworkRule) bool

type VirtualNetworkRuleProperties 

type VirtualNetworkRuleProperties struct {
	IgnoreMissingVnetServiceEndpoint *bool                    `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
	State                            *VirtualNetworkRuleState `json:"state,omitempty"`
	VirtualNetworkSubnetId           string                   `json:"virtualNetworkSubnetId"`
}

type VirtualNetworkRuleState 

type VirtualNetworkRuleState string
const (
	VirtualNetworkRuleStateDeleting     VirtualNetworkRuleState = "Deleting"
	VirtualNetworkRuleStateInProgress   VirtualNetworkRuleState = "InProgress"
	VirtualNetworkRuleStateInitializing VirtualNetworkRuleState = "Initializing"
	VirtualNetworkRuleStateReady        VirtualNetworkRuleState = "Ready"
	VirtualNetworkRuleStateUnknown      VirtualNetworkRuleState = "Unknown"
)

type VirtualNetworkRulesClient 

type VirtualNetworkRulesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewVirtualNetworkRulesClientWithBaseURI 

func NewVirtualNetworkRulesClientWithBaseURI(endpoint string) VirtualNetworkRulesClient

func (VirtualNetworkRulesClient) CreateOrUpdate 

func (c VirtualNetworkRulesClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkRuleId, input VirtualNetworkRule) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (VirtualNetworkRulesClient) CreateOrUpdateThenPoll 

func (c VirtualNetworkRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualNetworkRuleId, input VirtualNetworkRule) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VirtualNetworkRulesClient) Delete 

func (c VirtualNetworkRulesClient) Delete(ctx context.Context, id VirtualNetworkRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (VirtualNetworkRulesClient) DeleteThenPoll 

func (c VirtualNetworkRulesClient) DeleteThenPoll(ctx context.Context, id VirtualNetworkRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VirtualNetworkRulesClient) Get 

func (c VirtualNetworkRulesClient) Get(ctx context.Context, id VirtualNetworkRuleId) (result GetOperationResponse, err error)

Get ...

func (VirtualNetworkRulesClient) ListByServer 

func (c VirtualNetworkRulesClient) ListByServer(ctx context.Context, id ServerId) (resp ListByServerOperationResponse, err error)

ListByServer ...

func (VirtualNetworkRulesClient) ListByServerComplete 

func (c VirtualNetworkRulesClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all of the results into a single object

func (VirtualNetworkRulesClient) ListByServerCompleteMatchingPredicate 

func (c VirtualNetworkRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate VirtualNetworkRuleOperationPredicate) (resp ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all of the results and then applied the predicate

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.