vpnsites

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-11-01/vpnsites Documentation

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

Client Initialization

client := vpnsites.NewVpnSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VpnSitesClient.UpdateTags

ctx := context.TODO()
id := vpnsites.NewVpnSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vpnSiteValue")

payload := vpnsites.TagsObject{
	// ...
}


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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateVpnSiteID(input interface{}, key string) (warnings []string, errors []error)
• type AddressSpace
• type BgpSettings
• type DeviceProperties
• type IPConfigurationBgpPeeringAddress
• type O365BreakOutCategoryPolicies
• type O365PolicyProperties
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type SubResource
• type TagsObject
• type UpdateTagsOperationResponse
• type VpnLinkBgpSettings
• type VpnLinkProviderProperties
• type VpnSite
• type VpnSiteId
  • func NewVpnSiteID(subscriptionId string, resourceGroupName string, vpnSiteName string) VpnSiteId
  • func ParseVpnSiteID(input string) (*VpnSiteId, error)
  • func ParseVpnSiteIDInsensitively(input string) (*VpnSiteId, error)
  • func (id VpnSiteId) ID() string
  • func (id VpnSiteId) Segments() []resourceids.Segment
  • func (id VpnSiteId) String() string
• type VpnSiteLink
• type VpnSiteLinkProperties
• type VpnSiteProperties
• type VpnSitesClient
  • func NewVpnSitesClientWithBaseURI(api environments.Api) (*VpnSitesClient, error)
  • func (c VpnSitesClient) UpdateTags(ctx context.Context, id VpnSiteId, input TagsObject) (result UpdateTagsOperationResponse, err error)

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateVpnSiteID

func ValidateVpnSiteID(input interface{}, key string) (warnings []string, errors []error)

ValidateVpnSiteID checks that 'input' can be parsed as a Vpn Site ID

Types

type AddressSpace

type AddressSpace struct {
	AddressPrefixes *[]string `json:"addressPrefixes,omitempty"`
}

type BgpSettings

type BgpSettings struct {
	Asn                 *int64                              `json:"asn,omitempty"`
	BgpPeeringAddress   *string                             `json:"bgpPeeringAddress,omitempty"`
	BgpPeeringAddresses *[]IPConfigurationBgpPeeringAddress `json:"bgpPeeringAddresses,omitempty"`
	PeerWeight          *int64                              `json:"peerWeight,omitempty"`
}

type DeviceProperties

type DeviceProperties struct {
	DeviceModel     *string `json:"deviceModel,omitempty"`
	DeviceVendor    *string `json:"deviceVendor,omitempty"`
	LinkSpeedInMbps *int64  `json:"linkSpeedInMbps,omitempty"`
}

type IPConfigurationBgpPeeringAddress

type IPConfigurationBgpPeeringAddress struct {
	CustomBgpIPAddresses  *[]string `json:"customBgpIpAddresses,omitempty"`
	DefaultBgpIPAddresses *[]string `json:"defaultBgpIpAddresses,omitempty"`
	IPconfigurationId     *string   `json:"ipconfigurationId,omitempty"`
	TunnelIPAddresses     *[]string `json:"tunnelIpAddresses,omitempty"`
}

type O365BreakOutCategoryPolicies

type O365BreakOutCategoryPolicies struct {
	Allow    *bool `json:"allow,omitempty"`
	Default  *bool `json:"default,omitempty"`
	Optimize *bool `json:"optimize,omitempty"`
}

type O365PolicyProperties

type O365PolicyProperties struct {
	BreakOutCategories *O365BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type SubResource

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type TagsObject

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VpnSite
}

type VpnLinkBgpSettings

type VpnLinkBgpSettings struct {
	Asn               *int64  `json:"asn,omitempty"`
	BgpPeeringAddress *string `json:"bgpPeeringAddress,omitempty"`
}

type VpnLinkProviderProperties

type VpnLinkProviderProperties struct {
	LinkProviderName *string `json:"linkProviderName,omitempty"`
	LinkSpeedInMbps  *int64  `json:"linkSpeedInMbps,omitempty"`
}

type VpnSite

type VpnSite struct {
	Etag       *string            `json:"etag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   string             `json:"location"`
	Name       *string            `json:"name,omitempty"`
	Properties *VpnSiteProperties `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type VpnSiteId

type VpnSiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	VpnSiteName       string
}

VpnSiteId is a struct representing the Resource ID for a Vpn Site

func NewVpnSiteID

func NewVpnSiteID(subscriptionId string, resourceGroupName string, vpnSiteName string) VpnSiteId

NewVpnSiteID returns a new VpnSiteId struct

func ParseVpnSiteID

func ParseVpnSiteID(input string) (*VpnSiteId, error)

ParseVpnSiteID parses 'input' into a VpnSiteId

func ParseVpnSiteIDInsensitively

func ParseVpnSiteIDInsensitively(input string) (*VpnSiteId, error)

ParseVpnSiteIDInsensitively parses 'input' case-insensitively into a VpnSiteId note: this method should only be used for API response data and not user input

func (VpnSiteId) ID

func (id VpnSiteId) ID() string

ID returns the formatted Vpn Site ID

func (VpnSiteId) Segments

func (id VpnSiteId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Vpn Site ID

func (VpnSiteId) String

func (id VpnSiteId) String() string

String returns a human-readable description of this Vpn Site ID

type VpnSiteLink

type VpnSiteLink struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *VpnSiteLinkProperties `json:"properties,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type VpnSiteLinkProperties

type VpnSiteLinkProperties struct {
	BgpProperties     *VpnLinkBgpSettings        `json:"bgpProperties,omitempty"`
	Fqdn              *string                    `json:"fqdn,omitempty"`
	IPAddress         *string                    `json:"ipAddress,omitempty"`
	LinkProperties    *VpnLinkProviderProperties `json:"linkProperties,omitempty"`
	ProvisioningState *ProvisioningState         `json:"provisioningState,omitempty"`
}

type VpnSiteProperties

type VpnSiteProperties struct {
	AddressSpace      *AddressSpace         `json:"addressSpace,omitempty"`
	BgpProperties     *BgpSettings          `json:"bgpProperties,omitempty"`
	DeviceProperties  *DeviceProperties     `json:"deviceProperties,omitempty"`
	IPAddress         *string               `json:"ipAddress,omitempty"`
	IsSecuritySite    *bool                 `json:"isSecuritySite,omitempty"`
	O365Policy        *O365PolicyProperties `json:"o365Policy,omitempty"`
	ProvisioningState *ProvisioningState    `json:"provisioningState,omitempty"`
	SiteKey           *string               `json:"siteKey,omitempty"`
	VirtualWAN        *SubResource          `json:"virtualWan,omitempty"`
	VpnSiteLinks      *[]VpnSiteLink        `json:"vpnSiteLinks,omitempty"`
}

type VpnSitesClient

type VpnSitesClient struct {
	Client *resourcemanager.Client
}

func NewVpnSitesClientWithBaseURI

func NewVpnSitesClientWithBaseURI(api environments.Api) (*VpnSitesClient, error)

func (VpnSitesClient) UpdateTags

func (c VpnSitesClient) UpdateTags(ctx context.Context, id VpnSiteId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...