README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/postgresqlhsc/2022-11-08/firewallrules
Documentation
The firewallrules
SDK allows for interaction with the Azure Resource Manager Service postgresqlhsc
(API Version 2022-11-08
).
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/postgresqlhsc/2022-11-08/firewallrules"
Client Initialization
client := firewallrules.NewFirewallRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: FirewallRulesClient.CreateOrUpdate
ctx := context.TODO()
id := firewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "firewallRuleValue")
payload := firewallrules.FirewallRule{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: FirewallRulesClient.Delete
ctx := context.TODO()
id := firewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "firewallRuleValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: FirewallRulesClient.Get
ctx := context.TODO()
id := firewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "firewallRuleValue")
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: FirewallRulesClient.ListByCluster
ctx := context.TODO()
id := firewallrules.NewServerGroupsv2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value")
read, err := client.ListByCluster(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForProvisioningState() []string
- func ValidateFirewallRuleID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServerGroupsv2ID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type FirewallRule
- type FirewallRuleId
- type FirewallRuleListResult
- type FirewallRuleProperties
- type FirewallRulesClient
- func (c FirewallRulesClient) CreateOrUpdate(ctx context.Context, id FirewallRuleId, input FirewallRule) (result CreateOrUpdateOperationResponse, err error)
- func (c FirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id FirewallRuleId, input FirewallRule) error
- func (c FirewallRulesClient) Delete(ctx context.Context, id FirewallRuleId) (result DeleteOperationResponse, err error)
- func (c FirewallRulesClient) DeleteThenPoll(ctx context.Context, id FirewallRuleId) error
- func (c FirewallRulesClient) Get(ctx context.Context, id FirewallRuleId) (result GetOperationResponse, err error)
- func (c FirewallRulesClient) ListByCluster(ctx context.Context, id ServerGroupsv2Id) (result ListByClusterOperationResponse, err error)
- type GetOperationResponse
- type ListByClusterOperationResponse
- type ProvisioningState
- type ServerGroupsv2Id
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateFirewallRuleID ¶
ValidateFirewallRuleID checks that 'input' can be parsed as a Firewall Rule ID
func ValidateServerGroupsv2ID ¶
ValidateServerGroupsv2ID checks that 'input' can be parsed as a Server Groupsv 2 ID
Types ¶
type DeleteOperationResponse ¶
type FirewallRule ¶
type FirewallRule struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties FirewallRuleProperties `json:"properties"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type FirewallRuleId ¶
type FirewallRuleId struct { SubscriptionId string ResourceGroupName string ServerGroupsv2Name string FirewallRuleName string }
FirewallRuleId is a struct representing the Resource ID for a Firewall Rule
func NewFirewallRuleID ¶
func NewFirewallRuleID(subscriptionId string, resourceGroupName string, serverGroupsv2Name string, firewallRuleName string) FirewallRuleId
NewFirewallRuleID returns a new FirewallRuleId struct
func ParseFirewallRuleID ¶
func ParseFirewallRuleID(input string) (*FirewallRuleId, error)
ParseFirewallRuleID parses 'input' into a FirewallRuleId
func ParseFirewallRuleIDInsensitively ¶
func ParseFirewallRuleIDInsensitively(input string) (*FirewallRuleId, error)
ParseFirewallRuleIDInsensitively parses 'input' case-insensitively into a FirewallRuleId note: this method should only be used for API response data and not user input
func (*FirewallRuleId) FromParseResult ¶
func (id *FirewallRuleId) FromParseResult(input resourceids.ParseResult) error
func (FirewallRuleId) ID ¶
func (id FirewallRuleId) ID() string
ID returns the formatted Firewall Rule ID
func (FirewallRuleId) Segments ¶
func (id FirewallRuleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Firewall Rule ID
func (FirewallRuleId) String ¶
func (id FirewallRuleId) String() string
String returns a human-readable description of this Firewall Rule ID
type FirewallRuleListResult ¶
type FirewallRuleListResult struct {
Value *[]FirewallRule `json:"value,omitempty"`
}
type FirewallRuleProperties ¶
type FirewallRuleProperties struct { EndIPAddress string `json:"endIpAddress"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` StartIPAddress string `json:"startIpAddress"` }
type FirewallRulesClient ¶
type FirewallRulesClient struct {
Client *resourcemanager.Client
}
func NewFirewallRulesClientWithBaseURI ¶
func NewFirewallRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*FirewallRulesClient, error)
func (FirewallRulesClient) CreateOrUpdate ¶
func (c FirewallRulesClient) CreateOrUpdate(ctx context.Context, id FirewallRuleId, input FirewallRule) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (FirewallRulesClient) CreateOrUpdateThenPoll ¶
func (c FirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id FirewallRuleId, input FirewallRule) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (FirewallRulesClient) Delete ¶
func (c FirewallRulesClient) Delete(ctx context.Context, id FirewallRuleId) (result DeleteOperationResponse, err error)
Delete ...
func (FirewallRulesClient) DeleteThenPoll ¶
func (c FirewallRulesClient) DeleteThenPoll(ctx context.Context, id FirewallRuleId) error
DeleteThenPoll performs Delete then polls until it's completed
func (FirewallRulesClient) Get ¶
func (c FirewallRulesClient) Get(ctx context.Context, id FirewallRuleId) (result GetOperationResponse, err error)
Get ...
func (FirewallRulesClient) ListByCluster ¶
func (c FirewallRulesClient) ListByCluster(ctx context.Context, id ServerGroupsv2Id) (result ListByClusterOperationResponse, err error)
ListByCluster ...
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *FirewallRule }
type ListByClusterOperationResponse ¶
type ListByClusterOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *FirewallRuleListResult }
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateInProgress ProvisioningState = "InProgress" ProvisioningStateSucceeded ProvisioningState = "Succeeded" )
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type ServerGroupsv2Id ¶
type ServerGroupsv2Id struct { SubscriptionId string ResourceGroupName string ServerGroupsv2Name string }
ServerGroupsv2Id is a struct representing the Resource ID for a Server Groupsv 2
func NewServerGroupsv2ID ¶
func NewServerGroupsv2ID(subscriptionId string, resourceGroupName string, serverGroupsv2Name string) ServerGroupsv2Id
NewServerGroupsv2ID returns a new ServerGroupsv2Id struct
func ParseServerGroupsv2ID ¶
func ParseServerGroupsv2ID(input string) (*ServerGroupsv2Id, error)
ParseServerGroupsv2ID parses 'input' into a ServerGroupsv2Id
func ParseServerGroupsv2IDInsensitively ¶
func ParseServerGroupsv2IDInsensitively(input string) (*ServerGroupsv2Id, error)
ParseServerGroupsv2IDInsensitively parses 'input' case-insensitively into a ServerGroupsv2Id note: this method should only be used for API response data and not user input
func (*ServerGroupsv2Id) FromParseResult ¶
func (id *ServerGroupsv2Id) FromParseResult(input resourceids.ParseResult) error
func (ServerGroupsv2Id) ID ¶
func (id ServerGroupsv2Id) ID() string
ID returns the formatted Server Groupsv 2 ID
func (ServerGroupsv2Id) Segments ¶
func (id ServerGroupsv2Id) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Server Groupsv 2 ID
func (ServerGroupsv2Id) String ¶
func (id ServerGroupsv2Id) String() string
String returns a human-readable description of this Server Groupsv 2 ID