simpolicy

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The simpolicy SDK allows for interaction with Azure Resource Manager 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/simpolicy"

Client Initialization

client := simpolicy.NewSIMPolicyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMPolicyClient.SimPoliciesCreateOrUpdate

ctx := context.TODO()
id := simpolicy.NewSimPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkName", "simPolicyName")

payload := simpolicy.SimPolicy{
	// ...
}


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

Example Usage: SIMPolicyClient.SimPoliciesDelete

ctx := context.TODO()
id := simpolicy.NewSimPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkName", "simPolicyName")

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

Example Usage: SIMPolicyClient.SimPoliciesGet

ctx := context.TODO()
id := simpolicy.NewSimPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkName", "simPolicyName")

read, err := client.SimPoliciesGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SIMPolicyClient.SimPoliciesUpdateTags

ctx := context.TODO()
id := simpolicy.NewSimPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkName", "simPolicyName")

payload := simpolicy.TagsObject{
	// ...
}


read, err := client.SimPoliciesUpdateTags(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 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 ValidateSimPolicyID 

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

ValidateSimPolicyID checks that 'input' can be parsed as a Sim Policy 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 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 SIMPolicyClient 

type SIMPolicyClient struct {
	Client *resourcemanager.Client
}

func NewSIMPolicyClientWithBaseURI 

func NewSIMPolicyClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMPolicyClient, error)

func (SIMPolicyClient) SimPoliciesCreateOrUpdate 

func (c SIMPolicyClient) SimPoliciesCreateOrUpdate(ctx context.Context, id SimPolicyId, input SimPolicy) (result SimPoliciesCreateOrUpdateOperationResponse, err error)

SimPoliciesCreateOrUpdate ...

func (SIMPolicyClient) SimPoliciesCreateOrUpdateThenPoll 

func (c SIMPolicyClient) SimPoliciesCreateOrUpdateThenPoll(ctx context.Context, id SimPolicyId, input SimPolicy) error

SimPoliciesCreateOrUpdateThenPoll performs SimPoliciesCreateOrUpdate then polls until it's completed

func (SIMPolicyClient) SimPoliciesDelete 

func (c SIMPolicyClient) SimPoliciesDelete(ctx context.Context, id SimPolicyId) (result SimPoliciesDeleteOperationResponse, err error)

SimPoliciesDelete ...

func (SIMPolicyClient) SimPoliciesDeleteThenPoll 

func (c SIMPolicyClient) SimPoliciesDeleteThenPoll(ctx context.Context, id SimPolicyId) error

SimPoliciesDeleteThenPoll performs SimPoliciesDelete then polls until it's completed

func (SIMPolicyClient) SimPoliciesGet 

func (c SIMPolicyClient) SimPoliciesGet(ctx context.Context, id SimPolicyId) (result SimPoliciesGetOperationResponse, err error)

SimPoliciesGet ...

func (SIMPolicyClient) SimPoliciesUpdateTags 

func (c SIMPolicyClient) SimPoliciesUpdateTags(ctx context.Context, id SimPolicyId, input TagsObject) (result SimPoliciesUpdateTagsOperationResponse, err error)

SimPoliciesUpdateTags ...

type ServiceResourceId 

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

type SimPoliciesCreateOrUpdateOperationResponse 

type SimPoliciesCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SimPolicy
}

type SimPoliciesDeleteOperationResponse 

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

type SimPoliciesGetOperationResponse 

type SimPoliciesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SimPolicy
}

type SimPoliciesUpdateTagsOperationResponse 

type SimPoliciesUpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SimPolicy
}

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 SimPolicyId 

type SimPolicyId struct {
	SubscriptionId    string
	ResourceGroupName string
	MobileNetworkName string
	SimPolicyName     string
}

SimPolicyId is a struct representing the Resource ID for a Sim Policy

func NewSimPolicyID 

func NewSimPolicyID(subscriptionId string, resourceGroupName string, mobileNetworkName string, simPolicyName string) SimPolicyId

NewSimPolicyID returns a new SimPolicyId struct

func ParseSimPolicyID 

func ParseSimPolicyID(input string) (*SimPolicyId, error)

ParseSimPolicyID parses 'input' into a SimPolicyId

func ParseSimPolicyIDInsensitively 

func ParseSimPolicyIDInsensitively(input string) (*SimPolicyId, error)

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

func (*SimPolicyId) FromParseResult 

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

func (SimPolicyId) ID 

func (id SimPolicyId) ID() string

ID returns the formatted Sim Policy ID

func (SimPolicyId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sim Policy ID

func (SimPolicyId) String 

func (id SimPolicyId) String() string

String returns a human-readable description of this Sim Policy ID

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"`
}

type TagsObject 

type TagsObject struct {
	Tags *map[string]string `json:"tags,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.