packetcoredataplanes

package
v0.20241128.1112539 Latest Latest
Warning

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

Go to latest
Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2023-09-01/packetcoredataplanes Documentation

The packetcoredataplanes SDK allows for interaction with Azure Resource Manager mobilenetwork (API Version 2023-09-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/2023-09-01/packetcoredataplanes"

Client Initialization

client := packetcoredataplanes.NewPacketCoreDataPlanesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PacketCoreDataPlanesClient.ListByPacketCoreControlPlane

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

// alternatively `client.ListByPacketCoreControlPlane(ctx, id)` can be used to do batched pagination
items, err := client.ListByPacketCoreControlPlaneComplete(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 PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

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 InterfaceProperties

type InterfaceProperties struct {
	IPv4Address *string `json:"ipv4Address,omitempty"`
	IPv4Gateway *string `json:"ipv4Gateway,omitempty"`
	IPv4Subnet  *string `json:"ipv4Subnet,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type ListByPacketCoreControlPlaneCompleteResult

type ListByPacketCoreControlPlaneCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PacketCoreDataPlane
}

type ListByPacketCoreControlPlaneCustomPager added in v0.20240628.1153531

type ListByPacketCoreControlPlaneCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

type ListByPacketCoreControlPlaneOperationResponse

type ListByPacketCoreControlPlaneOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PacketCoreDataPlane
}

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

ID returns the formatted Packet Core Control Plane ID

func (PacketCoreControlPlaneId) Segments

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 PacketCoreDataPlane

type PacketCoreDataPlane struct {
	Id         *string                             `json:"id,omitempty"`
	Location   string                              `json:"location"`
	Name       *string                             `json:"name,omitempty"`
	Properties PacketCoreDataPlanePropertiesFormat `json:"properties"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type PacketCoreDataPlaneOperationPredicate

type PacketCoreDataPlaneOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (PacketCoreDataPlaneOperationPredicate) Matches

type PacketCoreDataPlanePropertiesFormat

type PacketCoreDataPlanePropertiesFormat struct {
	ProvisioningState                   *ProvisioningState  `json:"provisioningState,omitempty"`
	UserPlaneAccessInterface            InterfaceProperties `json:"userPlaneAccessInterface"`
	UserPlaneAccessVirtualIPv4Addresses *[]string           `json:"userPlaneAccessVirtualIpv4Addresses,omitempty"`
}

type PacketCoreDataPlanesClient

type PacketCoreDataPlanesClient struct {
	Client *resourcemanager.Client
}

func NewPacketCoreDataPlanesClientWithBaseURI

func NewPacketCoreDataPlanesClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreDataPlanesClient, error)

func (PacketCoreDataPlanesClient) ListByPacketCoreControlPlane

ListByPacketCoreControlPlane ...

func (PacketCoreDataPlanesClient) ListByPacketCoreControlPlaneComplete

ListByPacketCoreControlPlaneComplete retrieves all the results into a single object

func (PacketCoreDataPlanesClient) ListByPacketCoreControlPlaneCompleteMatchingPredicate

func (c PacketCoreDataPlanesClient) ListByPacketCoreControlPlaneCompleteMatchingPredicate(ctx context.Context, id PacketCoreControlPlaneId, predicate PacketCoreDataPlaneOperationPredicate) (result ListByPacketCoreControlPlaneCompleteResult, err error)

ListByPacketCoreControlPlaneCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleted   ProvisioningState = "Deleted"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUnknown   ProvisioningState = "Unknown"
)

func (*ProvisioningState) UnmarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL