ueinformationlist

README

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

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

Client Initialization

client := ueinformationlist.NewUeInformationListClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UeInformationListClient.UeInformationList

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

// alternatively `client.UeInformationList(ctx, id)` can be used to do batched pagination
items, err := client.UeInformationListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForRatType() []string
• func PossibleValuesForUeState() []string
• func ValidatePacketCoreControlPlaneID(input interface{}, key string) (warnings []string, errors []error)
• type DnnIPPair
• type PacketCoreControlPlaneId
  • func NewPacketCoreControlPlaneID(subscriptionId string, resourceGroupName string, ...) PacketCoreControlPlaneId
  • func ParsePacketCoreControlPlaneID(input string) (*PacketCoreControlPlaneId, error)
  • func ParsePacketCoreControlPlaneIDInsensitively(input string) (*PacketCoreControlPlaneId, error)
  • func (id *PacketCoreControlPlaneId) FromParseResult(input resourceids.ParseResult) error
  • func (id PacketCoreControlPlaneId) ID() string
  • func (id PacketCoreControlPlaneId) Segments() []resourceids.Segment
  • func (id PacketCoreControlPlaneId) String() string
• type RatType
  • func (s *RatType) UnmarshalJSON(bytes []byte) error
• type UeIPAddress
• type UeInfo
• type UeInfoOperationPredicate
  • func (p UeInfoOperationPredicate) Matches(input UeInfo) bool
• type UeInfoPropertiesFormat
  • func (o *UeInfoPropertiesFormat) GetLastReadAtAsTime() (*time.Time, error)
  • func (o *UeInfoPropertiesFormat) SetLastReadAtAsTime(input time.Time)
• type UeInformationListClient
  • func NewUeInformationListClientWithBaseURI(sdkApi sdkEnv.Api) (*UeInformationListClient, error)
  • func (c UeInformationListClient) UeInformationList(ctx context.Context, id PacketCoreControlPlaneId) (result UeInformationListOperationResponse, err error)
  • func (c UeInformationListClient) UeInformationListComplete(ctx context.Context, id PacketCoreControlPlaneId) (UeInformationListCompleteResult, error)
  • func (c UeInformationListClient) UeInformationListCompleteMatchingPredicate(ctx context.Context, id PacketCoreControlPlaneId, ...) (result UeInformationListCompleteResult, err error)
• type UeInformationListCompleteResult
• type UeInformationListOperationResponse
• type UeState
  • func (s *UeState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForRatType

func PossibleValuesForRatType() []string

func PossibleValuesForUeState

func PossibleValuesForUeState() []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 DnnIPPair

type DnnIPPair struct {
	Dnn         *string      `json:"dnn,omitempty"`
	UeIPAddress *UeIPAddress `json:"ueIpAddress,omitempty"`
}

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 RatType

type RatType string

const (
	RatTypeFiveG RatType = "5G"
	RatTypeFourG RatType = "4G"
)

func (*RatType) UnmarshalJSON

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

type UeIPAddress

type UeIPAddress struct {
	IPV4Addr *string `json:"ipV4Addr,omitempty"`
}

type UeInfo

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

type UeInfoOperationPredicate

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

func (UeInfoOperationPredicate) Matches

func (p UeInfoOperationPredicate) Matches(input UeInfo) bool

type UeInfoPropertiesFormat

type UeInfoPropertiesFormat struct {
	LastReadAt    *string      `json:"lastReadAt,omitempty"`
	RatType       RatType      `json:"ratType"`
	UeIPAddresses *[]DnnIPPair `json:"ueIpAddresses,omitempty"`
	UeState       UeState      `json:"ueState"`
}

func (*UeInfoPropertiesFormat) GetLastReadAtAsTime

func (o *UeInfoPropertiesFormat) GetLastReadAtAsTime() (*time.Time, error)

func (*UeInfoPropertiesFormat) SetLastReadAtAsTime

func (o *UeInfoPropertiesFormat) SetLastReadAtAsTime(input time.Time)

type UeInformationListClient

type UeInformationListClient struct {
	Client *resourcemanager.Client
}

func NewUeInformationListClientWithBaseURI

func NewUeInformationListClientWithBaseURI(sdkApi sdkEnv.Api) (*UeInformationListClient, error)

func (UeInformationListClient) UeInformationList

func (c UeInformationListClient) UeInformationList(ctx context.Context, id PacketCoreControlPlaneId) (result UeInformationListOperationResponse, err error)

UeInformationList ...

func (UeInformationListClient) UeInformationListComplete

func (c UeInformationListClient) UeInformationListComplete(ctx context.Context, id PacketCoreControlPlaneId) (UeInformationListCompleteResult, error)

UeInformationListComplete retrieves all the results into a single object

func (UeInformationListClient) UeInformationListCompleteMatchingPredicate

func (c UeInformationListClient) UeInformationListCompleteMatchingPredicate(ctx context.Context, id PacketCoreControlPlaneId, predicate UeInfoOperationPredicate) (result UeInformationListCompleteResult, err error)

UeInformationListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type UeInformationListCompleteResult

type UeInformationListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []UeInfo
}

type UeInformationListOperationResponse

type UeInformationListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]UeInfo
}

type UeState

type UeState string

const (
	UeStateConnected    UeState = "Connected"
	UeStateDeregistered UeState = "Deregistered"
	UeStateDetached     UeState = "Detached"
	UeStateIdle         UeState = "Idle"
	UeStateUnknown      UeState = "Unknown"
)

func (*UeState) UnmarshalJSON

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