firewallrules

package
v0.20230118.1184540 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2021-05-01/firewallrules Documentation

The firewallrules SDK allows for interaction with the Azure Resource Manager Service mysql (API Version 2021-05-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/mysql/2021-05-01/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", "serverValue", "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", "serverValue", "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", "serverValue", "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.ListByServer

ctx := context.TODO()
id := firewallrules.NewFlexibleServerID("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 ValidateFirewallRuleID

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

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

func ValidateFlexibleServerID

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server 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 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
	ServerName        string
	FirewallRuleName  string
}

FirewallRuleId is a struct representing the Resource ID for a Firewall Rule

func NewFirewallRuleID

func NewFirewallRuleID(subscriptionId string, resourceGroupName string, serverName 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) 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 FirewallRuleOperationPredicate

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

func (FirewallRuleOperationPredicate) Matches

type FirewallRuleProperties

type FirewallRuleProperties struct {
	EndIPAddress   string `json:"endIpAddress"`
	StartIPAddress string `json:"startIpAddress"`
}

type FirewallRulesClient

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

func NewFirewallRulesClientWithBaseURI

func NewFirewallRulesClientWithBaseURI(endpoint string) FirewallRulesClient

func (FirewallRulesClient) CreateOrUpdate

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

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

Get ...

func (FirewallRulesClient) ListByServer

ListByServer ...

func (FirewallRulesClient) ListByServerComplete

ListByServerComplete retrieves all of the results into a single object

func (FirewallRulesClient) ListByServerCompleteMatchingPredicate

func (c FirewallRulesClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, predicate FirewallRuleOperationPredicate) (resp ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type FlexibleServerId

type FlexibleServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, serverName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (FlexibleServerId) ID

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments

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

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

func (FlexibleServerId) String

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type GetOperationResponse

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

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []FirewallRule
}

type ListByServerOperationResponse

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

func (ListByServerOperationResponse) HasMore

func (r ListByServerOperationResponse) HasMore() bool

func (ListByServerOperationResponse) LoadMore

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL