README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/sql/2021-02-01-preview/outboundfirewallrules
Documentation
The outboundfirewallrules
SDK allows for interaction with the Azure Resource Manager Service sql
(API Version 2021-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-sdk/resource-manager/sql/2021-02-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", "serverValue", "outboundFirewallRuleValue")
payload := outboundfirewallrules.OutboundFirewallRule{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: OutboundFirewallRulesClient.Delete
ctx := context.TODO()
id := outboundfirewallrules.NewOutboundFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "outboundFirewallRuleValue")
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", "serverValue", "outboundFirewallRuleValue")
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 := outboundfirewallrules.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 ¶
- func ValidateOutboundFirewallRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServerID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByServerCompleteResult
- type ListByServerOperationResponse
- type OutboundFirewallRule
- type OutboundFirewallRuleId
- type OutboundFirewallRuleOperationPredicate
- type OutboundFirewallRuleProperties
- type OutboundFirewallRulesClient
- func (c OutboundFirewallRulesClient) CreateOrUpdate(ctx context.Context, id OutboundFirewallRuleId, input OutboundFirewallRule) (result CreateOrUpdateOperationResponse, err error)
- func (c OutboundFirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id OutboundFirewallRuleId, input OutboundFirewallRule) error
- func (c OutboundFirewallRulesClient) Delete(ctx context.Context, id OutboundFirewallRuleId) (result DeleteOperationResponse, err error)
- func (c OutboundFirewallRulesClient) DeleteThenPoll(ctx context.Context, id OutboundFirewallRuleId) error
- func (c OutboundFirewallRulesClient) Get(ctx context.Context, id OutboundFirewallRuleId) (result GetOperationResponse, err error)
- func (c OutboundFirewallRulesClient) ListByServer(ctx context.Context, id ServerId) (result ListByServerOperationResponse, err error)
- func (c OutboundFirewallRulesClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)
- func (c OutboundFirewallRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, ...) (result ListByServerCompleteResult, err error)
- type ServerId
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
func ValidateServerID ¶
ValidateServerID checks that 'input' can be parsed as a Server ID
Types ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *OutboundFirewallRule }
type ListByServerCompleteResult ¶
type ListByServerCompleteResult struct {
Items []OutboundFirewallRule
}
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) 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 ¶
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(api environments.Api) (*OutboundFirewallRulesClient, error)
func (OutboundFirewallRulesClient) CreateOrUpdate ¶
func (c OutboundFirewallRulesClient) CreateOrUpdate(ctx context.Context, id OutboundFirewallRuleId, input OutboundFirewallRule) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (OutboundFirewallRulesClient) CreateOrUpdateThenPoll ¶
func (c OutboundFirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id OutboundFirewallRuleId, input OutboundFirewallRule) 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 ServerId) (result ListByServerOperationResponse, err error)
ListByServer ...
func (OutboundFirewallRulesClient) ListByServerComplete ¶
func (c OutboundFirewallRulesClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)
ListByServerComplete retrieves all the results into a single object
func (OutboundFirewallRulesClient) ListByServerCompleteMatchingPredicate ¶
func (c OutboundFirewallRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate OutboundFirewallRuleOperationPredicate) (result ListByServerCompleteResult, err error)
ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate
type ServerId ¶
ServerId is a struct representing the Resource ID for a Server
func NewServerID ¶
NewServerID returns a new ServerId struct
func ParseServerID ¶
ParseServerID parses 'input' into a ServerId
func ParseServerIDInsensitively ¶
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) Segments ¶
func (id ServerId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Server ID