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/network/2023-04-01/securityrules
Documentation
The securityrules
SDK allows for interaction with the Azure Resource Manager Service network
(API Version 2023-04-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/network/2023-04-01/securityrules"
Client Initialization
client := securityrules.NewSecurityRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SecurityRulesClient.CreateOrUpdate
ctx := context.TODO()
id := securityrules.NewSecurityRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue", "securityRuleValue")
payload := securityrules.SecurityRule{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SecurityRulesClient.DefaultSecurityRulesGet
ctx := context.TODO()
id := securityrules.NewDefaultSecurityRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue", "defaultSecurityRuleValue")
read, err := client.DefaultSecurityRulesGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SecurityRulesClient.DefaultSecurityRulesList
ctx := context.TODO()
id := securityrules.NewNetworkSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue")
// alternatively `client.DefaultSecurityRulesList(ctx, id)` can be used to do batched pagination
items, err := client.DefaultSecurityRulesListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: SecurityRulesClient.Delete
ctx := context.TODO()
id := securityrules.NewSecurityRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue", "securityRuleValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SecurityRulesClient.Get
ctx := context.TODO()
id := securityrules.NewSecurityRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue", "securityRuleValue")
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: SecurityRulesClient.List
ctx := context.TODO()
id := securityrules.NewNetworkSecurityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkSecurityGroupValue")
// 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
NewDefaultSecurityRuleID returns a new DefaultSecurityRuleId struct.
NewNetworkSecurityGroupID returns a new NetworkSecurityGroupId struct.
NewSecurityRuleID returns a new SecurityRuleId struct.
No description provided by the author
ParseDefaultSecurityRuleID parses 'input' into a DefaultSecurityRuleId.
ParseDefaultSecurityRuleIDInsensitively parses 'input' case-insensitively into a DefaultSecurityRuleId note: this method should only be used for API response data and not user input.
ParseNetworkSecurityGroupID parses 'input' into a NetworkSecurityGroupId.
ParseNetworkSecurityGroupIDInsensitively parses 'input' case-insensitively into a NetworkSecurityGroupId note: this method should only be used for API response data and not user input.
ParseSecurityRuleID parses 'input' into a SecurityRuleId.
ParseSecurityRuleIDInsensitively parses 'input' case-insensitively into a SecurityRuleId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateDefaultSecurityRuleID checks that 'input' can be parsed as a Default Security Rule ID.
ValidateNetworkSecurityGroupID checks that 'input' can be parsed as a Network Security Group ID.
ValidateSecurityRuleID checks that 'input' can be parsed as a Security Rule 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
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
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
DefaultSecurityRuleId is a struct representing the Resource ID for a Default Security 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
NetworkSecurityGroupId is a struct representing the Resource ID for a Network Security Group.
No description provided by the author
SecurityRuleId is a struct representing the Resource ID for a Security Rule.
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author