localnetworkgateways

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

The localnetworkgateways 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/localnetworkgateways"

Client Initialization

client := localnetworkgateways.NewLocalNetworkGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocalNetworkGatewaysClient.CreateOrUpdate

ctx := context.TODO()
id := localnetworkgateways.NewLocalNetworkGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "localNetworkGatewayName")

payload := localnetworkgateways.LocalNetworkGateway{
	// ...
}


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

Example Usage: LocalNetworkGatewaysClient.Delete

ctx := context.TODO()
id := localnetworkgateways.NewLocalNetworkGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "localNetworkGatewayName")

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

Example Usage: LocalNetworkGatewaysClient.Get

ctx := context.TODO()
id := localnetworkgateways.NewLocalNetworkGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "localNetworkGatewayName")

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

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

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

Example Usage: LocalNetworkGatewaysClient.UpdateTags

ctx := context.TODO()
id := localnetworkgateways.NewLocalNetworkGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "localNetworkGatewayName")

payload := localnetworkgateways.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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateLocalNetworkGatewayID 

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

ValidateLocalNetworkGatewayID checks that 'input' can be parsed as a Local Network Gateway 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 CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LocalNetworkGateway
}

type DeleteOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LocalNetworkGateway
}

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 ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []LocalNetworkGateway
}

type ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]LocalNetworkGateway
}

type LocalNetworkGateway 

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

type LocalNetworkGatewayId 

type LocalNetworkGatewayId struct {
	SubscriptionId          string
	ResourceGroupName       string
	LocalNetworkGatewayName string
}

LocalNetworkGatewayId is a struct representing the Resource ID for a Local Network Gateway

func NewLocalNetworkGatewayID 

func NewLocalNetworkGatewayID(subscriptionId string, resourceGroupName string, localNetworkGatewayName string) LocalNetworkGatewayId

NewLocalNetworkGatewayID returns a new LocalNetworkGatewayId struct

func ParseLocalNetworkGatewayID 

func ParseLocalNetworkGatewayID(input string) (*LocalNetworkGatewayId, error)

ParseLocalNetworkGatewayID parses 'input' into a LocalNetworkGatewayId

func ParseLocalNetworkGatewayIDInsensitively 

func ParseLocalNetworkGatewayIDInsensitively(input string) (*LocalNetworkGatewayId, error)

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

func (*LocalNetworkGatewayId) FromParseResult 

func (id *LocalNetworkGatewayId) FromParseResult(input resourceids.ParseResult) error

func (LocalNetworkGatewayId) ID 

func (id LocalNetworkGatewayId) ID() string

ID returns the formatted Local Network Gateway ID

func (LocalNetworkGatewayId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Local Network Gateway ID

func (LocalNetworkGatewayId) String 

func (id LocalNetworkGatewayId) String() string

String returns a human-readable description of this Local Network Gateway ID

type LocalNetworkGatewayOperationPredicate 

type LocalNetworkGatewayOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (LocalNetworkGatewayOperationPredicate) Matches 

func (p LocalNetworkGatewayOperationPredicate) Matches(input LocalNetworkGateway) bool

type LocalNetworkGatewayPropertiesFormat 

type LocalNetworkGatewayPropertiesFormat struct {
	BgpSettings              *BgpSettings       `json:"bgpSettings,omitempty"`
	Fqdn                     *string            `json:"fqdn,omitempty"`
	GatewayIPAddress         *string            `json:"gatewayIpAddress,omitempty"`
	LocalNetworkAddressSpace *AddressSpace      `json:"localNetworkAddressSpace,omitempty"`
	ProvisioningState        *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid             *string            `json:"resourceGuid,omitempty"`
}

type LocalNetworkGatewaysClient 

type LocalNetworkGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewLocalNetworkGatewaysClientWithBaseURI 

func NewLocalNetworkGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*LocalNetworkGatewaysClient, error)

func (LocalNetworkGatewaysClient) CreateOrUpdate 

func (c LocalNetworkGatewaysClient) CreateOrUpdate(ctx context.Context, id LocalNetworkGatewayId, input LocalNetworkGateway) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (LocalNetworkGatewaysClient) CreateOrUpdateThenPoll 

func (c LocalNetworkGatewaysClient) CreateOrUpdateThenPoll(ctx context.Context, id LocalNetworkGatewayId, input LocalNetworkGateway) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (LocalNetworkGatewaysClient) Delete 

func (c LocalNetworkGatewaysClient) Delete(ctx context.Context, id LocalNetworkGatewayId) (result DeleteOperationResponse, err error)

Delete ...

func (LocalNetworkGatewaysClient) DeleteThenPoll 

func (c LocalNetworkGatewaysClient) DeleteThenPoll(ctx context.Context, id LocalNetworkGatewayId) error

DeleteThenPoll performs Delete then polls until it's completed

func (LocalNetworkGatewaysClient) Get 

func (c LocalNetworkGatewaysClient) Get(ctx context.Context, id LocalNetworkGatewayId) (result GetOperationResponse, err error)

Get ...

func (LocalNetworkGatewaysClient) List 

func (c LocalNetworkGatewaysClient) List(ctx context.Context, id commonids.ResourceGroupId) (result ListOperationResponse, err error)

List ...

func (LocalNetworkGatewaysClient) ListComplete 

func (c LocalNetworkGatewaysClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (LocalNetworkGatewaysClient) ListCompleteMatchingPredicate 

func (c LocalNetworkGatewaysClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate LocalNetworkGatewayOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (LocalNetworkGatewaysClient) UpdateTags 

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

UpdateTags ...

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 TagsObject 

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

type UpdateTagsOperationResponse 

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

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.