README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/vpnsites
Documentation
The vpnsites
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/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
- type SubResource
- type TagsObject
- type UpdateTagsOperationResponse
- type VpnLinkBgpSettings
- type VpnLinkProviderProperties
- type VpnSite
- type VpnSiteId
- type VpnSiteLink
- type VpnSiteLinkProperties
- type VpnSiteProperties
- type VpnSitesClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateVpnSiteID ¶
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 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 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 VpnLinkBgpSettings ¶
type VpnSite ¶
type VpnSite struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *VpnSiteProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type VpnSiteId ¶
VpnSiteId is a struct representing the Resource ID for a Vpn Site
func NewVpnSiteID ¶
NewVpnSiteID returns a new VpnSiteId struct
func ParseVpnSiteID ¶
ParseVpnSiteID parses 'input' into a VpnSiteId
func ParseVpnSiteIDInsensitively ¶
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) FromParseResult ¶
func (id *VpnSiteId) FromParseResult(input resourceids.ParseResult) error
func (VpnSiteId) Segments ¶
func (id VpnSiteId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise 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(sdkApi sdkEnv.Api) (*VpnSitesClient, error)
func (VpnSitesClient) UpdateTags ¶
func (c VpnSitesClient) UpdateTags(ctx context.Context, id VpnSiteId, input TagsObject) (result UpdateTagsOperationResponse, err error)
UpdateTags ...
Source Files ¶
- client.go
- constants.go
- id_vpnsite.go
- method_updatetags.go
- model_addressspace.go
- model_bgpsettings.go
- model_deviceproperties.go
- model_ipconfigurationbgppeeringaddress.go
- model_o365breakoutcategorypolicies.go
- model_o365policyproperties.go
- model_subresource.go
- model_tagsobject.go
- model_vpnlinkbgpsettings.go
- model_vpnlinkproviderproperties.go
- model_vpnsite.go
- model_vpnsitelink.go
- model_vpnsitelinkproperties.go
- model_vpnsiteproperties.go
- version.go