outboundfirewallrules

package
v0.20241111.1164443 Latest Latest
Warning

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

 Go to latest Published: Nov 11, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The outboundfirewallrules SDK allows for interaction with Azure Resource Manager sql (API Version 2023-08-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-08-01-preview/outboundfirewallrules"

Client Initialization

client := outboundfirewallrules.NewOutboundFirewallRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OutboundFirewallRulesClient.CreateOrUpdate

ctx := context.TODO()
id := outboundfirewallrules.NewOutboundFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "outboundFirewallRuleName")

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

Example Usage: OutboundFirewallRulesClient.Delete

ctx := context.TODO()
id := outboundfirewallrules.NewOutboundFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "outboundFirewallRuleName")

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

Example Usage: OutboundFirewallRulesClient.Get

ctx := context.TODO()
id := outboundfirewallrules.NewOutboundFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName", "outboundFirewallRuleName")

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

ctx := context.TODO()
id := commonids.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverName")

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

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

ValidateOutboundFirewallRuleID checks that 'input' can be parsed as a Outbound Firewall Rule ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OutboundFirewallRule
}

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        *OutboundFirewallRule
}

type ListByServerCompleteResult 

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

type ListByServerCustomPager 

type ListByServerCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByServerCustomPager) NextPageLink() *odata.Link

type ListByServerOperationResponse 

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

type OutboundFirewallRule 

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

type OutboundFirewallRuleId 

type OutboundFirewallRuleId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ServerName               string
	OutboundFirewallRuleName string
}

OutboundFirewallRuleId is a struct representing the Resource ID for a Outbound Firewall Rule

func NewOutboundFirewallRuleID 

func NewOutboundFirewallRuleID(subscriptionId string, resourceGroupName string, serverName string, outboundFirewallRuleName string) OutboundFirewallRuleId

NewOutboundFirewallRuleID returns a new OutboundFirewallRuleId struct

func ParseOutboundFirewallRuleID 

func ParseOutboundFirewallRuleID(input string) (*OutboundFirewallRuleId, error)

ParseOutboundFirewallRuleID parses 'input' into a OutboundFirewallRuleId

func ParseOutboundFirewallRuleIDInsensitively 

func ParseOutboundFirewallRuleIDInsensitively(input string) (*OutboundFirewallRuleId, error)

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

func (*OutboundFirewallRuleId) FromParseResult 

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

func (OutboundFirewallRuleId) ID 

func (id OutboundFirewallRuleId) ID() string

ID returns the formatted Outbound Firewall Rule ID

func (OutboundFirewallRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Outbound Firewall Rule ID

func (OutboundFirewallRuleId) String 

func (id OutboundFirewallRuleId) String() string

String returns a human-readable description of this Outbound Firewall Rule ID

type OutboundFirewallRuleOperationPredicate 

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

func (OutboundFirewallRuleOperationPredicate) Matches 

func (p OutboundFirewallRuleOperationPredicate) Matches(input OutboundFirewallRule) bool

type OutboundFirewallRuleProperties 

type OutboundFirewallRuleProperties struct {
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

type OutboundFirewallRulesClient 

type OutboundFirewallRulesClient struct {
	Client *resourcemanager.Client
}

func NewOutboundFirewallRulesClientWithBaseURI 

func NewOutboundFirewallRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*OutboundFirewallRulesClient, error)

func (OutboundFirewallRulesClient) CreateOrUpdate 

func (c OutboundFirewallRulesClient) CreateOrUpdate(ctx context.Context, id OutboundFirewallRuleId) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (OutboundFirewallRulesClient) CreateOrUpdateThenPoll 

func (c OutboundFirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id OutboundFirewallRuleId) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (OutboundFirewallRulesClient) Delete 

func (c OutboundFirewallRulesClient) Delete(ctx context.Context, id OutboundFirewallRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (OutboundFirewallRulesClient) DeleteThenPoll 

func (c OutboundFirewallRulesClient) DeleteThenPoll(ctx context.Context, id OutboundFirewallRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (OutboundFirewallRulesClient) Get 

func (c OutboundFirewallRulesClient) Get(ctx context.Context, id OutboundFirewallRuleId) (result GetOperationResponse, err error)

Get ...

func (OutboundFirewallRulesClient) ListByServer 

func (c OutboundFirewallRulesClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (OutboundFirewallRulesClient) ListByServerComplete 

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

ListByServerComplete retrieves all the results into a single object

func (OutboundFirewallRulesClient) ListByServerCompleteMatchingPredicate 

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

ListByServerCompleteMatchingPredicate retrieves all the results and then applies 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.