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

# README

github.com/hashicorp/go-azure-sdk/resource-manager/redis/2023-08-01/firewallrules Documentation

The firewallrules SDK allows for interaction with the Azure Resource Manager Service redis (API Version 2023-08-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/redis/2023-08-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", "redisValue", "firewallRuleValue")

payload := firewallrules.RedisFirewallRule{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: FirewallRulesClient.Delete

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

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: FirewallRulesClient.Get

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

ctx := context.TODO()
id := firewallrules.NewRediID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisValue")

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

# Functions

NewFirewallRuleID returns a new FirewallRuleId struct.
No description provided by the author
NewRediID returns a new RediId 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.
ParseRediID parses 'input' into a RediId.
ParseRediIDInsensitively parses 'input' case-insensitively into a RediId note: this method should only be used for API response data and not user input.
ValidateFirewallRuleID checks that 'input' can be parsed as a Firewall Rule ID.
ValidateRediID checks that 'input' can be parsed as a Redi ID.

# 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
RediId is a struct representing the Resource ID for a Redi.
No description provided by the author
No description provided by the author
No description provided by the author