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/networkgroups
Documentation
The networkgroups
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/networkgroups"
Client Initialization
client := networkgroups.NewNetworkGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: NetworkGroupsClient.CreateOrUpdate
ctx := context.TODO()
id := networkgroups.NewNetworkGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue")
payload := networkgroups.NetworkGroup{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, networkgroups.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: NetworkGroupsClient.Delete
ctx := context.TODO()
id := networkgroups.NewNetworkGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue")
if err := client.DeleteThenPoll(ctx, id, networkgroups.DefaultDeleteOperationOptions()); err != nil {
// handle the error
}
Example Usage: NetworkGroupsClient.Get
ctx := context.TODO()
id := networkgroups.NewNetworkGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue", "networkGroupValue")
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: NetworkGroupsClient.List
ctx := context.TODO()
id := networkgroups.NewNetworkManagerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerValue")
// alternatively `client.List(ctx, id, networkgroups.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, networkgroups.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
NewNetworkGroupID returns a new NetworkGroupId struct.
No description provided by the author
NewNetworkManagerID returns a new NetworkManagerId struct.
ParseNetworkGroupID parses 'input' into a NetworkGroupId.
ParseNetworkGroupIDInsensitively parses 'input' case-insensitively into a NetworkGroupId note: this method should only be used for API response data and not user input.
ParseNetworkManagerID parses 'input' into a NetworkManagerId.
ParseNetworkManagerIDInsensitively parses 'input' case-insensitively into a NetworkManagerId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateNetworkGroupID checks that 'input' can be parsed as a Network Group ID.
ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager 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
# Structs
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
NetworkGroupId is a struct representing the Resource ID for a Network Group.
No description provided by the author
No description provided by the author
No description provided by the author
NetworkManagerId is a struct representing the Resource ID for a Network Manager.
# Type aliases
No description provided by the author