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-06-01/virtualrouterpeerings Documentation

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

Client Initialization

client := virtualrouterpeerings.NewVirtualRouterPeeringsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualRouterPeeringsClient.CreateOrUpdate

ctx := context.TODO()
id := virtualrouterpeerings.NewVirtualRouterPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualRouterValue", "peeringValue")

payload := virtualrouterpeerings.VirtualRouterPeering{
	// ...
}


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

Example Usage: VirtualRouterPeeringsClient.Delete

ctx := context.TODO()
id := virtualrouterpeerings.NewVirtualRouterPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualRouterValue", "peeringValue")

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

Example Usage: VirtualRouterPeeringsClient.Get

ctx := context.TODO()
id := virtualrouterpeerings.NewVirtualRouterPeeringID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualRouterValue", "peeringValue")

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: VirtualRouterPeeringsClient.List

ctx := context.TODO()
id := virtualrouterpeerings.NewVirtualRouterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualRouterValue")

// 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

NewVirtualRouterID returns a new VirtualRouterId struct.
No description provided by the author
ParseVirtualRouterID parses 'input' into a VirtualRouterId.
ParseVirtualRouterIDInsensitively parses 'input' case-insensitively into a VirtualRouterId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateVirtualRouterID checks that 'input' can be parsed as a Virtual Router 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
VirtualRouterId is a struct representing the Resource ID for a Virtual Router.
No description provided by the author
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