virtualnetworkrules

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/virtualnetworkrules Documentation

The virtualnetworkrules SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/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 := commonids.NewSqlServerID("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

• func PossibleValuesForVirtualNetworkRuleState() []string
• func ValidateVirtualNetworkRuleID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByServerCompleteResult
• type ListByServerOperationResponse
• type VirtualNetworkRule
• type VirtualNetworkRuleId
  • func NewVirtualNetworkRuleID(subscriptionId string, resourceGroupName string, serverName string, ...) VirtualNetworkRuleId
  • func ParseVirtualNetworkRuleID(input string) (*VirtualNetworkRuleId, error)
  • func ParseVirtualNetworkRuleIDInsensitively(input string) (*VirtualNetworkRuleId, error)
  • func (id *VirtualNetworkRuleId) FromParseResult(input resourceids.ParseResult) error
  • func (id VirtualNetworkRuleId) ID() string
  • func (id VirtualNetworkRuleId) Segments() []resourceids.Segment
  • func (id VirtualNetworkRuleId) String() string
• type VirtualNetworkRuleOperationPredicate
  • func (p VirtualNetworkRuleOperationPredicate) Matches(input VirtualNetworkRule) bool
• type VirtualNetworkRuleProperties
• type VirtualNetworkRuleState
  • func (s *VirtualNetworkRuleState) UnmarshalJSON(bytes []byte) error
• type VirtualNetworkRulesClient
  • func NewVirtualNetworkRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualNetworkRulesClient, error)
  • func (c VirtualNetworkRulesClient) CreateOrUpdate(ctx context.Context, id VirtualNetworkRuleId, input VirtualNetworkRule) (result CreateOrUpdateOperationResponse, err error)
  • func (c VirtualNetworkRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id VirtualNetworkRuleId, input VirtualNetworkRule) error
  • func (c VirtualNetworkRulesClient) Delete(ctx context.Context, id VirtualNetworkRuleId) (result DeleteOperationResponse, err error)
  • func (c VirtualNetworkRulesClient) DeleteThenPoll(ctx context.Context, id VirtualNetworkRuleId) error
  • func (c VirtualNetworkRulesClient) Get(ctx context.Context, id VirtualNetworkRuleId) (result GetOperationResponse, err error)
  • func (c VirtualNetworkRulesClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)
  • func (c VirtualNetworkRulesClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)
  • func (c VirtualNetworkRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, ...) (result ListByServerCompleteResult, err error)

Functions

func PossibleValuesForVirtualNetworkRuleState

func PossibleValuesForVirtualNetworkRuleState() []string

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       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VirtualNetworkRule
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByServerCompleteResult

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

type ListByServerOperationResponse

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

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) FromParseResult

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

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"
	VirtualNetworkRuleStateFailed       VirtualNetworkRuleState = "Failed"
	VirtualNetworkRuleStateInProgress   VirtualNetworkRuleState = "InProgress"
	VirtualNetworkRuleStateInitializing VirtualNetworkRuleState = "Initializing"
	VirtualNetworkRuleStateReady        VirtualNetworkRuleState = "Ready"
	VirtualNetworkRuleStateUnknown      VirtualNetworkRuleState = "Unknown"
)

func (*VirtualNetworkRuleState) UnmarshalJSON

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

type VirtualNetworkRulesClient

type VirtualNetworkRulesClient struct {
	Client *resourcemanager.Client
}

func NewVirtualNetworkRulesClientWithBaseURI

func NewVirtualNetworkRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualNetworkRulesClient, error)

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 commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (VirtualNetworkRulesClient) ListByServerComplete

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

ListByServerComplete retrieves all the results into a single object

func (VirtualNetworkRulesClient) ListByServerCompleteMatchingPredicate

func (c VirtualNetworkRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate VirtualNetworkRuleOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate