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-05-01/virtualappliancesites Documentation

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

Client Initialization

client := virtualappliancesites.NewVirtualApplianceSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualApplianceSitesClient.CreateOrUpdate

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

payload := virtualappliancesites.VirtualApplianceSite{
	// ...
}


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

Example Usage: VirtualApplianceSitesClient.Delete

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

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

Example Usage: VirtualApplianceSitesClient.Get

ctx := context.TODO()
id := virtualappliancesites.NewVirtualApplianceSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue", "virtualApplianceSiteValue")

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

ctx := context.TODO()
id := virtualappliancesites.NewNetworkVirtualApplianceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkVirtualApplianceValue")

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

NewNetworkVirtualApplianceID returns a new NetworkVirtualApplianceId struct.
NewVirtualApplianceSiteID returns a new VirtualApplianceSiteId struct.
No description provided by the author
ParseNetworkVirtualApplianceID parses 'input' into a NetworkVirtualApplianceId.
ParseNetworkVirtualApplianceIDInsensitively parses 'input' case-insensitively into a NetworkVirtualApplianceId note: this method should only be used for API response data and not user input.
ParseVirtualApplianceSiteID parses 'input' into a VirtualApplianceSiteId.
ParseVirtualApplianceSiteIDInsensitively parses 'input' case-insensitively into a VirtualApplianceSiteId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateNetworkVirtualApplianceID checks that 'input' can be parsed as a Network Virtual Appliance ID.
ValidateVirtualApplianceSiteID checks that 'input' can be parsed as a Virtual Appliance Site 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
NetworkVirtualApplianceId is a struct representing the Resource ID for a Network Virtual Appliance.
No description provided by the author
No description provided by the author
VirtualApplianceSiteId is a struct representing the Resource ID for a Virtual Appliance Site.
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