ipfirewallrules

package
v0.20240320.1105218 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/ipfirewallrules Documentation

The ipfirewallrules SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-01/ipfirewallrules"

Client Initialization

client := ipfirewallrules.NewIPFirewallRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IPFirewallRulesClient.CreateOrUpdate

ctx := context.TODO()
id := ipfirewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "firewallRuleValue")

payload := ipfirewallrules.IPFirewallRuleInfo{
	// ...
}


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

Example Usage: IPFirewallRulesClient.Delete

ctx := context.TODO()
id := ipfirewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "firewallRuleValue")

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

Example Usage: IPFirewallRulesClient.Get

ctx := context.TODO()
id := ipfirewallrules.NewFirewallRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "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: IPFirewallRulesClient.ListByWorkspace

ctx := context.TODO()
id := ipfirewallrules.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")

// alternatively `client.ListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.ListByWorkspaceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IPFirewallRulesClient.ReplaceAll

ctx := context.TODO()
id := ipfirewallrules.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")

payload := ipfirewallrules.ReplaceAllIPFirewallRulesRequest{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

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 ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type FirewallRuleId 

type FirewallRuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	FirewallRuleName  string
}

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

func NewFirewallRuleID 

func NewFirewallRuleID(subscriptionId string, resourceGroupName string, workspaceName 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 GetOperationResponse 

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

type IPFirewallRuleInfo 

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

type IPFirewallRuleInfoOperationPredicate 

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

func (IPFirewallRuleInfoOperationPredicate) Matches 

func (p IPFirewallRuleInfoOperationPredicate) Matches(input IPFirewallRuleInfo) bool

type IPFirewallRuleProperties 

type IPFirewallRuleProperties struct {
	EndIPAddress      *string            `json:"endIpAddress,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	StartIPAddress    *string            `json:"startIpAddress,omitempty"`
}

type IPFirewallRulesClient 

type IPFirewallRulesClient struct {
	Client *resourcemanager.Client
}

func NewIPFirewallRulesClientWithBaseURI 

func NewIPFirewallRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*IPFirewallRulesClient, error)

func (IPFirewallRulesClient) CreateOrUpdate 

func (c IPFirewallRulesClient) CreateOrUpdate(ctx context.Context, id FirewallRuleId, input IPFirewallRuleInfo) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (IPFirewallRulesClient) CreateOrUpdateThenPoll 

func (c IPFirewallRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id FirewallRuleId, input IPFirewallRuleInfo) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (IPFirewallRulesClient) Delete 

func (c IPFirewallRulesClient) Delete(ctx context.Context, id FirewallRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (IPFirewallRulesClient) DeleteThenPoll 

func (c IPFirewallRulesClient) DeleteThenPoll(ctx context.Context, id FirewallRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IPFirewallRulesClient) Get 

func (c IPFirewallRulesClient) Get(ctx context.Context, id FirewallRuleId) (result GetOperationResponse, err error)

Get ...

func (IPFirewallRulesClient) ListByWorkspace 

func (c IPFirewallRulesClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

func (IPFirewallRulesClient) ListByWorkspaceComplete 

func (c IPFirewallRulesClient) ListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (ListByWorkspaceCompleteResult, error)

ListByWorkspaceComplete retrieves all the results into a single object

func (IPFirewallRulesClient) ListByWorkspaceCompleteMatchingPredicate 

func (c IPFirewallRulesClient) ListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate IPFirewallRuleInfoOperationPredicate) (result ListByWorkspaceCompleteResult, err error)

ListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IPFirewallRulesClient) ReplaceAll 

func (c IPFirewallRulesClient) ReplaceAll(ctx context.Context, id WorkspaceId, input ReplaceAllIPFirewallRulesRequest) (result ReplaceAllOperationResponse, err error)

ReplaceAll ...

func (IPFirewallRulesClient) ReplaceAllThenPoll 

func (c IPFirewallRulesClient) ReplaceAllThenPoll(ctx context.Context, id WorkspaceId, input ReplaceAllIPFirewallRulesRequest) error

ReplaceAllThenPoll performs ReplaceAll then polls until it's completed

type ListByWorkspaceCompleteResult 

type ListByWorkspaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IPFirewallRuleInfo
}

type ListByWorkspaceOperationResponse 

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IPFirewallRuleInfo
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleteError  ProvisioningState = "DeleteError"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type ReplaceAllFirewallRulesOperationResponse 

type ReplaceAllFirewallRulesOperationResponse struct {
	OperationId *string `json:"operationId,omitempty"`
}

type ReplaceAllIPFirewallRulesRequest 

type ReplaceAllIPFirewallRulesRequest struct {
	IPFirewallRules *map[string]IPFirewallRuleProperties `json:"ipFirewallRules,omitempty"`
}

type ReplaceAllOperationResponse 

type ReplaceAllOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReplaceAllFirewallRulesOperationResponse
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

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.