simpolicies

package
v0.20240223.1145617 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2023-06-01/simpolicies Documentation

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

Client Initialization

client := simpolicies.NewSIMPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMPoliciesClient.ListByMobileNetwork

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

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

func PossibleValuesForPduSessionType() []string

func PossibleValuesForPreemptionCapability

func PossibleValuesForPreemptionCapability() []string

func PossibleValuesForPreemptionVulnerability

func PossibleValuesForPreemptionVulnerability() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSiteProvisioningState

func PossibleValuesForSiteProvisioningState() []string

func ValidateMobileNetworkID

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

ValidateMobileNetworkID checks that 'input' can be parsed as a Mobile Network ID

Types

type Ambr

type Ambr struct {
	Downlink string `json:"downlink"`
	Uplink   string `json:"uplink"`
}

type DataNetworkConfiguration

type DataNetworkConfiguration struct {
	AdditionalAllowedSessionTypes       *[]PduSessionType        `json:"additionalAllowedSessionTypes,omitempty"`
	AllocationAndRetentionPriorityLevel *int64                   `json:"allocationAndRetentionPriorityLevel,omitempty"`
	AllowedServices                     []ServiceResourceId      `json:"allowedServices"`
	DataNetwork                         DataNetworkResourceId    `json:"dataNetwork"`
	DefaultSessionType                  *PduSessionType          `json:"defaultSessionType,omitempty"`
	Fiveqi                              *int64                   `json:"5qi,omitempty"`
	MaximumNumberOfBufferedPackets      *int64                   `json:"maximumNumberOfBufferedPackets,omitempty"`
	PreemptionCapability                *PreemptionCapability    `json:"preemptionCapability,omitempty"`
	PreemptionVulnerability             *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"`
	SessionAmbr                         Ambr                     `json:"sessionAmbr"`
}

type DataNetworkResourceId

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

type ListByMobileNetworkCompleteResult

type ListByMobileNetworkCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SimPolicy
}

type ListByMobileNetworkOperationResponse

type ListByMobileNetworkOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SimPolicy
}

type MobileNetworkId

type MobileNetworkId struct {
	SubscriptionId    string
	ResourceGroupName string
	MobileNetworkName string
}

MobileNetworkId is a struct representing the Resource ID for a Mobile Network

func NewMobileNetworkID

func NewMobileNetworkID(subscriptionId string, resourceGroupName string, mobileNetworkName string) MobileNetworkId

NewMobileNetworkID returns a new MobileNetworkId struct

func ParseMobileNetworkID

func ParseMobileNetworkID(input string) (*MobileNetworkId, error)

ParseMobileNetworkID parses 'input' into a MobileNetworkId

func ParseMobileNetworkIDInsensitively

func ParseMobileNetworkIDInsensitively(input string) (*MobileNetworkId, error)

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

func (*MobileNetworkId) FromParseResult

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

func (MobileNetworkId) ID

func (id MobileNetworkId) ID() string

ID returns the formatted Mobile Network ID

func (MobileNetworkId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Mobile Network ID

func (MobileNetworkId) String

func (id MobileNetworkId) String() string

String returns a human-readable description of this Mobile Network ID

type PduSessionType

type PduSessionType string
const (
	PduSessionTypeIPvFour PduSessionType = "IPv4"
	PduSessionTypeIPvSix  PduSessionType = "IPv6"
)

func (*PduSessionType) UnmarshalJSON

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

type PreemptionCapability

type PreemptionCapability string
const (
	PreemptionCapabilityMayPreempt PreemptionCapability = "MayPreempt"
	PreemptionCapabilityNotPreempt PreemptionCapability = "NotPreempt"
)

func (*PreemptionCapability) UnmarshalJSON

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

type PreemptionVulnerability

type PreemptionVulnerability string
const (
	PreemptionVulnerabilityNotPreemptable PreemptionVulnerability = "NotPreemptable"
	PreemptionVulnerabilityPreemptable    PreemptionVulnerability = "Preemptable"
)

func (*PreemptionVulnerability) UnmarshalJSON

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

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

type SIMPoliciesClient

type SIMPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewSIMPoliciesClientWithBaseURI

func NewSIMPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMPoliciesClient, error)

func (SIMPoliciesClient) ListByMobileNetwork

func (c SIMPoliciesClient) ListByMobileNetwork(ctx context.Context, id MobileNetworkId) (result ListByMobileNetworkOperationResponse, err error)

ListByMobileNetwork ...

func (SIMPoliciesClient) ListByMobileNetworkComplete

func (c SIMPoliciesClient) ListByMobileNetworkComplete(ctx context.Context, id MobileNetworkId) (ListByMobileNetworkCompleteResult, error)

ListByMobileNetworkComplete retrieves all the results into a single object

func (SIMPoliciesClient) ListByMobileNetworkCompleteMatchingPredicate

func (c SIMPoliciesClient) ListByMobileNetworkCompleteMatchingPredicate(ctx context.Context, id MobileNetworkId, predicate SimPolicyOperationPredicate) (result ListByMobileNetworkCompleteResult, err error)

ListByMobileNetworkCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServiceResourceId

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

type SimPolicy

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

type SimPolicyOperationPredicate

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

func (SimPolicyOperationPredicate) Matches

func (p SimPolicyOperationPredicate) Matches(input SimPolicy) bool

type SimPolicyPropertiesFormat

type SimPolicyPropertiesFormat struct {
	DefaultSlice          SliceResourceId                   `json:"defaultSlice"`
	ProvisioningState     *ProvisioningState                `json:"provisioningState,omitempty"`
	RegistrationTimer     *int64                            `json:"registrationTimer,omitempty"`
	RfspIndex             *int64                            `json:"rfspIndex,omitempty"`
	SiteProvisioningState *map[string]SiteProvisioningState `json:"siteProvisioningState,omitempty"`
	SliceConfigurations   []SliceConfiguration              `json:"sliceConfigurations"`
	UeAmbr                Ambr                              `json:"ueAmbr"`
}

type SiteProvisioningState

type SiteProvisioningState string
const (
	SiteProvisioningStateAdding        SiteProvisioningState = "Adding"
	SiteProvisioningStateDeleting      SiteProvisioningState = "Deleting"
	SiteProvisioningStateFailed        SiteProvisioningState = "Failed"
	SiteProvisioningStateNotApplicable SiteProvisioningState = "NotApplicable"
	SiteProvisioningStateProvisioned   SiteProvisioningState = "Provisioned"
	SiteProvisioningStateUpdating      SiteProvisioningState = "Updating"
)

func (*SiteProvisioningState) UnmarshalJSON

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

type SliceConfiguration

type SliceConfiguration struct {
	DataNetworkConfigurations []DataNetworkConfiguration `json:"dataNetworkConfigurations"`
	DefaultDataNetwork        DataNetworkResourceId      `json:"defaultDataNetwork"`
	Slice                     SliceResourceId            `json:"slice"`
}

type SliceResourceId

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

Jump to

Keyboard shortcuts

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