p2svpngateways

package
v0.20241029.1112340 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/p2svpngateways Documentation

The p2svpngateways SDK allows for interaction with Azure Resource Manager network (API Version 2023-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/p2svpngateways"

Client Initialization

client := p2svpngateways.NewP2sVpnGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: P2sVpnGatewaysClient.DisconnectP2sVpnConnections

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

payload := p2svpngateways.P2SVpnConnectionRequest{
	// ...
}


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

Example Usage: P2sVpnGatewaysClient.GenerateVpnProfile

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

payload := p2svpngateways.P2SVpnProfileParameters{
	// ...
}


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

Example Usage: P2sVpnGatewaysClient.GetP2sVpnConnectionHealth

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

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

Example Usage: P2sVpnGatewaysClient.GetP2sVpnConnectionHealthDetailed

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

payload := p2svpngateways.P2SVpnConnectionHealthRequest{
	// ...
}


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

Example Usage: P2sVpnGatewaysClient.Reset

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

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

Example Usage: P2sVpnGatewaysClient.UpdateTags

ctx := context.TODO()
id := commonids.NewVirtualWANP2SVPNGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "p2sVpnGatewayName")

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


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAuthenticationMethod 

func PossibleValuesForAuthenticationMethod() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForVnetLocalRouteOverrideCriteria 

func PossibleValuesForVnetLocalRouteOverrideCriteria() []string

func PossibleValuesForVpnPolicyMemberAttributeType 

func PossibleValuesForVpnPolicyMemberAttributeType() []string

Types

type AddressSpace 

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

type AuthenticationMethod 

type AuthenticationMethod string
const (
	AuthenticationMethodEAPMSCHAPvTwo AuthenticationMethod = "EAPMSCHAPv2"
	AuthenticationMethodEAPTLS        AuthenticationMethod = "EAPTLS"
)

func (*AuthenticationMethod) UnmarshalJSON 

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

type DisconnectP2sVpnConnectionsOperationResponse 

type DisconnectP2sVpnConnectionsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GenerateVpnProfileOperationResponse 

type GenerateVpnProfileOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VpnProfileResponse
}

type GetP2sVpnConnectionHealthDetailedOperationResponse 

type GetP2sVpnConnectionHealthDetailedOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *P2SVpnConnectionHealth
}

type GetP2sVpnConnectionHealthOperationResponse 

type GetP2sVpnConnectionHealthOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *P2SVpnGateway
}

type P2SConnectionConfiguration 

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

type P2SConnectionConfigurationProperties 

type P2SConnectionConfigurationProperties struct {
	ConfigurationPolicyGroupAssociations         *[]SubResource                       `json:"configurationPolicyGroupAssociations,omitempty"`
	EnableInternetSecurity                       *bool                                `json:"enableInternetSecurity,omitempty"`
	PreviousConfigurationPolicyGroupAssociations *[]VpnServerConfigurationPolicyGroup `json:"previousConfigurationPolicyGroupAssociations,omitempty"`
	ProvisioningState                            *ProvisioningState                   `json:"provisioningState,omitempty"`
	RoutingConfiguration                         *RoutingConfiguration                `json:"routingConfiguration,omitempty"`
	VpnClientAddressPool                         *AddressSpace                        `json:"vpnClientAddressPool,omitempty"`
}

type P2SVpnConnectionHealth 

type P2SVpnConnectionHealth struct {
	SasURL *string `json:"sasUrl,omitempty"`
}

type P2SVpnConnectionHealthRequest 

type P2SVpnConnectionHealthRequest struct {
	OutputBlobSasURL   *string   `json:"outputBlobSasUrl,omitempty"`
	VpnUserNamesFilter *[]string `json:"vpnUserNamesFilter,omitempty"`
}

type P2SVpnConnectionRequest 

type P2SVpnConnectionRequest struct {
	VpnConnectionIds *[]string `json:"vpnConnectionIds,omitempty"`
}

type P2SVpnGateway 

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

type P2SVpnGatewayProperties 

type P2SVpnGatewayProperties struct {
	CustomDnsServers            *[]string                     `json:"customDnsServers,omitempty"`
	IsRoutingPreferenceInternet *bool                         `json:"isRoutingPreferenceInternet,omitempty"`
	P2SConnectionConfigurations *[]P2SConnectionConfiguration `json:"p2SConnectionConfigurations,omitempty"`
	ProvisioningState           *ProvisioningState            `json:"provisioningState,omitempty"`
	VirtualHub                  *SubResource                  `json:"virtualHub,omitempty"`
	VpnClientConnectionHealth   *VpnClientConnectionHealth    `json:"vpnClientConnectionHealth,omitempty"`
	VpnGatewayScaleUnit         *int64                        `json:"vpnGatewayScaleUnit,omitempty"`
	VpnServerConfiguration      *SubResource                  `json:"vpnServerConfiguration,omitempty"`
}

type P2SVpnProfileParameters 

type P2SVpnProfileParameters struct {
	AuthenticationMethod *AuthenticationMethod `json:"authenticationMethod,omitempty"`
}

type P2sVpnGatewaysClient 

type P2sVpnGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewP2sVpnGatewaysClientWithBaseURI 

func NewP2sVpnGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*P2sVpnGatewaysClient, error)

func (P2sVpnGatewaysClient) DisconnectP2sVpnConnections 

func (c P2sVpnGatewaysClient) DisconnectP2sVpnConnections(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnConnectionRequest) (result DisconnectP2sVpnConnectionsOperationResponse, err error)

DisconnectP2sVpnConnections ...

func (P2sVpnGatewaysClient) DisconnectP2sVpnConnectionsThenPoll 

func (c P2sVpnGatewaysClient) DisconnectP2sVpnConnectionsThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnConnectionRequest) error

DisconnectP2sVpnConnectionsThenPoll performs DisconnectP2sVpnConnections then polls until it's completed

func (P2sVpnGatewaysClient) GenerateVpnProfile 

func (c P2sVpnGatewaysClient) GenerateVpnProfile(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnProfileParameters) (result GenerateVpnProfileOperationResponse, err error)

GenerateVpnProfile ...

func (P2sVpnGatewaysClient) GenerateVpnProfileThenPoll 

func (c P2sVpnGatewaysClient) GenerateVpnProfileThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnProfileParameters) error

GenerateVpnProfileThenPoll performs GenerateVpnProfile then polls until it's completed

func (P2sVpnGatewaysClient) GetP2sVpnConnectionHealth 

func (c P2sVpnGatewaysClient) GetP2sVpnConnectionHealth(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId) (result GetP2sVpnConnectionHealthOperationResponse, err error)

GetP2sVpnConnectionHealth ...

func (P2sVpnGatewaysClient) GetP2sVpnConnectionHealthDetailed 

func (c P2sVpnGatewaysClient) GetP2sVpnConnectionHealthDetailed(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnConnectionHealthRequest) (result GetP2sVpnConnectionHealthDetailedOperationResponse, err error)

GetP2sVpnConnectionHealthDetailed ...

func (P2sVpnGatewaysClient) GetP2sVpnConnectionHealthDetailedThenPoll 

func (c P2sVpnGatewaysClient) GetP2sVpnConnectionHealthDetailedThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input P2SVpnConnectionHealthRequest) error

GetP2sVpnConnectionHealthDetailedThenPoll performs GetP2sVpnConnectionHealthDetailed then polls until it's completed

func (P2sVpnGatewaysClient) GetP2sVpnConnectionHealthThenPoll 

func (c P2sVpnGatewaysClient) GetP2sVpnConnectionHealthThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId) error

GetP2sVpnConnectionHealthThenPoll performs GetP2sVpnConnectionHealth then polls until it's completed

func (P2sVpnGatewaysClient) Reset 

func (c P2sVpnGatewaysClient) Reset(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId) (result ResetOperationResponse, err error)

Reset ...

func (P2sVpnGatewaysClient) ResetThenPoll 

func (c P2sVpnGatewaysClient) ResetThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId) error

ResetThenPoll performs Reset then polls until it's completed

func (P2sVpnGatewaysClient) UpdateTags 

func (c P2sVpnGatewaysClient) UpdateTags(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

func (P2sVpnGatewaysClient) UpdateTagsThenPoll 

func (c P2sVpnGatewaysClient) UpdateTagsThenPoll(ctx context.Context, id commonids.VirtualWANP2SVPNGatewayId, input TagsObject) error

UpdateTagsThenPoll performs UpdateTags then polls until it's completed

type PropagatedRouteTable 

type PropagatedRouteTable struct {
	Ids    *[]SubResource `json:"ids,omitempty"`
	Labels *[]string      `json:"labels,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 ResetOperationResponse 

type ResetOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *P2SVpnGateway
}

type RoutingConfiguration 

type RoutingConfiguration struct {
	AssociatedRouteTable  *SubResource          `json:"associatedRouteTable,omitempty"`
	InboundRouteMap       *SubResource          `json:"inboundRouteMap,omitempty"`
	OutboundRouteMap      *SubResource          `json:"outboundRouteMap,omitempty"`
	PropagatedRouteTables *PropagatedRouteTable `json:"propagatedRouteTables,omitempty"`
	VnetRoutes            *VnetRoute            `json:"vnetRoutes,omitempty"`
}

type StaticRoute 

type StaticRoute struct {
	AddressPrefixes  *[]string `json:"addressPrefixes,omitempty"`
	Name             *string   `json:"name,omitempty"`
	NextHopIPAddress *string   `json:"nextHopIpAddress,omitempty"`
}

type StaticRoutesConfig 

type StaticRoutesConfig struct {
	PropagateStaticRoutes          *bool                           `json:"propagateStaticRoutes,omitempty"`
	VnetLocalRouteOverrideCriteria *VnetLocalRouteOverrideCriteria `json:"vnetLocalRouteOverrideCriteria,omitempty"`
}

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 {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *P2SVpnGateway
}

type VnetLocalRouteOverrideCriteria 

type VnetLocalRouteOverrideCriteria string
const (
	VnetLocalRouteOverrideCriteriaContains VnetLocalRouteOverrideCriteria = "Contains"
	VnetLocalRouteOverrideCriteriaEqual    VnetLocalRouteOverrideCriteria = "Equal"
)

func (*VnetLocalRouteOverrideCriteria) UnmarshalJSON 

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

type VnetRoute 

type VnetRoute struct {
	BgpConnections     *[]SubResource      `json:"bgpConnections,omitempty"`
	StaticRoutes       *[]StaticRoute      `json:"staticRoutes,omitempty"`
	StaticRoutesConfig *StaticRoutesConfig `json:"staticRoutesConfig,omitempty"`
}

type VpnClientConnectionHealth 

type VpnClientConnectionHealth struct {
	AllocatedIPAddresses         *[]string `json:"allocatedIpAddresses,omitempty"`
	TotalEgressBytesTransferred  *int64    `json:"totalEgressBytesTransferred,omitempty"`
	TotalIngressBytesTransferred *int64    `json:"totalIngressBytesTransferred,omitempty"`
	VpnClientConnectionsCount    *int64    `json:"vpnClientConnectionsCount,omitempty"`
}

type VpnPolicyMemberAttributeType 

type VpnPolicyMemberAttributeType string
const (
	VpnPolicyMemberAttributeTypeAADGroupId         VpnPolicyMemberAttributeType = "AADGroupId"
	VpnPolicyMemberAttributeTypeCertificateGroupId VpnPolicyMemberAttributeType = "CertificateGroupId"
	VpnPolicyMemberAttributeTypeRadiusAzureGroupId VpnPolicyMemberAttributeType = "RadiusAzureGroupId"
)

func (*VpnPolicyMemberAttributeType) UnmarshalJSON 

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

type VpnProfileResponse 

type VpnProfileResponse struct {
	ProfileURL *string `json:"profileUrl,omitempty"`
}

type VpnServerConfigurationPolicyGroup 

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

type VpnServerConfigurationPolicyGroupMember 

type VpnServerConfigurationPolicyGroupMember struct {
	AttributeType  *VpnPolicyMemberAttributeType `json:"attributeType,omitempty"`
	AttributeValue *string                       `json:"attributeValue,omitempty"`
	Name           *string                       `json:"name,omitempty"`
}

type VpnServerConfigurationPolicyGroupProperties 

type VpnServerConfigurationPolicyGroupProperties struct {
	IsDefault                   *bool                                      `json:"isDefault,omitempty"`
	P2SConnectionConfigurations *[]SubResource                             `json:"p2SConnectionConfigurations,omitempty"`
	PolicyMembers               *[]VpnServerConfigurationPolicyGroupMember `json:"policyMembers,omitempty"`
	Priority                    *int64                                     `json:"priority,omitempty"`
	ProvisioningState           *ProvisioningState                         `json:"provisioningState,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.