routinginfo

package
v0.20240903.1131440 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-04-01/routinginfo Documentation

The routinginfo SDK allows for interaction with the Azure Resource Manager Service mobilenetwork (API Version 2024-04-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/mobilenetwork/2024-04-01/routinginfo"

Client Initialization

client := routinginfo.NewRoutingInfoClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoutingInfoClient.Get

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidatePacketCoreControlPlaneID 

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

ValidatePacketCoreControlPlaneID checks that 'input' can be parsed as a Packet Core Control Plane ID

Types

type AttachedDataNetworkResourceId 

type AttachedDataNetworkResourceId struct {
	Id string `json:"id"`
}

type GetOperationResponse 

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

type IPv4Route 

type IPv4Route struct {
	Destination *string             `json:"destination,omitempty"`
	NextHops    *[]IPv4RouteNextHop `json:"nextHops,omitempty"`
}

type IPv4RouteNextHop 

type IPv4RouteNextHop struct {
	Address  *string `json:"address,omitempty"`
	Priority *int64  `json:"priority,omitempty"`
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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        *[]RoutingInfoModel
}

type PacketCoreControlPlaneId 

type PacketCoreControlPlaneId struct {
	SubscriptionId             string
	ResourceGroupName          string
	PacketCoreControlPlaneName string
}

PacketCoreControlPlaneId is a struct representing the Resource ID for a Packet Core Control Plane

func NewPacketCoreControlPlaneID 

func NewPacketCoreControlPlaneID(subscriptionId string, resourceGroupName string, packetCoreControlPlaneName string) PacketCoreControlPlaneId

NewPacketCoreControlPlaneID returns a new PacketCoreControlPlaneId struct

func ParsePacketCoreControlPlaneID 

func ParsePacketCoreControlPlaneID(input string) (*PacketCoreControlPlaneId, error)

ParsePacketCoreControlPlaneID parses 'input' into a PacketCoreControlPlaneId

func ParsePacketCoreControlPlaneIDInsensitively 

func ParsePacketCoreControlPlaneIDInsensitively(input string) (*PacketCoreControlPlaneId, error)

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

func (*PacketCoreControlPlaneId) FromParseResult 

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

func (PacketCoreControlPlaneId) ID 

func (id PacketCoreControlPlaneId) ID() string

ID returns the formatted Packet Core Control Plane ID

func (PacketCoreControlPlaneId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Packet Core Control Plane ID

func (PacketCoreControlPlaneId) String 

func (id PacketCoreControlPlaneId) String() string

String returns a human-readable description of this Packet Core Control Plane ID

type RoutingInfoClient 

type RoutingInfoClient struct {
	Client *resourcemanager.Client
}

func NewRoutingInfoClientWithBaseURI 

func NewRoutingInfoClientWithBaseURI(sdkApi sdkEnv.Api) (*RoutingInfoClient, error)

func (RoutingInfoClient) Get 

func (c RoutingInfoClient) Get(ctx context.Context, id PacketCoreControlPlaneId) (result GetOperationResponse, err error)

Get ...

func (RoutingInfoClient) List 

func (c RoutingInfoClient) List(ctx context.Context, id PacketCoreControlPlaneId) (result ListOperationResponse, err error)

List ...

func (RoutingInfoClient) ListComplete 

func (c RoutingInfoClient) ListComplete(ctx context.Context, id PacketCoreControlPlaneId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RoutingInfoClient) ListCompleteMatchingPredicate 

func (c RoutingInfoClient) ListCompleteMatchingPredicate(ctx context.Context, id PacketCoreControlPlaneId, predicate RoutingInfoModelOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RoutingInfoModel 

type RoutingInfoModel struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties RoutingInfoPropertiesFormat `json:"properties"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type RoutingInfoModelOperationPredicate 

type RoutingInfoModelOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (RoutingInfoModelOperationPredicate) Matches 

func (p RoutingInfoModelOperationPredicate) Matches(input RoutingInfoModel) bool

type RoutingInfoPropertiesFormat 

type RoutingInfoPropertiesFormat struct {
	ControlPlaneAccessRoutes *[]IPv4Route                                     `json:"controlPlaneAccessRoutes,omitempty"`
	UserPlaneAccessRoutes    *[]IPv4Route                                     `json:"userPlaneAccessRoutes,omitempty"`
	UserPlaneDataRoutes      *[]UserPlaneDataRoutesUserPlaneDataRoutesInlined `json:"userPlaneDataRoutes,omitempty"`
}

type UserPlaneDataRoutesUserPlaneDataRoutesInlined 

type UserPlaneDataRoutesUserPlaneDataRoutesInlined struct {
	AttachedDataNetwork *AttachedDataNetworkResourceId `json:"attachedDataNetwork,omitempty"`
	Routes              *[]IPv4Route                   `json:"routes,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.