package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# 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
}

# Functions

NewFirewallRuleID returns a new FirewallRuleId struct.
No description provided by the author
NewWorkspaceID returns a new WorkspaceId struct.
ParseFirewallRuleID parses 'input' into a FirewallRuleId.
ParseFirewallRuleIDInsensitively parses 'input' case-insensitively into a FirewallRuleId note: this method should only be used for API response data and not user input.
ParseWorkspaceID parses 'input' into a WorkspaceId.
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateFirewallRuleID checks that 'input' can be parsed as a Firewall Rule ID.
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
FirewallRuleId is a struct representing the Resource ID for a Firewall Rule.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WorkspaceId is a struct representing the Resource ID for a Workspace.

# Type aliases

No description provided by the author