sim

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-02-01/sim Documentation

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

Client Initialization

client := sim.NewSIMClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMClient.CreateOrUpdate

ctx := context.TODO()
id := sim.NewSimID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupName", "simName")

payload := sim.Sim{
	// ...
}


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

Example Usage: SIMClient.Delete

ctx := context.TODO()
id := sim.NewSimID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupName", "simName")

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

Example Usage: SIMClient.Get

ctx := context.TODO()
id := sim.NewSimID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupName", "simName")

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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSimState 

func PossibleValuesForSimState() []string

func PossibleValuesForSiteProvisioningState 

func PossibleValuesForSiteProvisioningState() []string

func ValidateSimID 

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

ValidateSimID checks that 'input' can be parsed as a Sim ID

Types

type AttachedDataNetworkResourceId 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Sim
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

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 SIMClient 

type SIMClient struct {
	Client *resourcemanager.Client
}

func NewSIMClientWithBaseURI 

func NewSIMClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMClient, error)

func (SIMClient) CreateOrUpdate 

func (c SIMClient) CreateOrUpdate(ctx context.Context, id SimId, input Sim) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SIMClient) CreateOrUpdateThenPoll 

func (c SIMClient) CreateOrUpdateThenPoll(ctx context.Context, id SimId, input Sim) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SIMClient) Delete 

func (c SIMClient) Delete(ctx context.Context, id SimId) (result DeleteOperationResponse, err error)

Delete ...

func (SIMClient) DeleteThenPoll 

func (c SIMClient) DeleteThenPoll(ctx context.Context, id SimId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SIMClient) Get 

func (c SIMClient) Get(ctx context.Context, id SimId) (result GetOperationResponse, err error)

Get ...

type Sim 

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

type SimId 

type SimId struct {
	SubscriptionId    string
	ResourceGroupName string
	SimGroupName      string
	SimName           string
}

SimId is a struct representing the Resource ID for a Sim

func NewSimID 

func NewSimID(subscriptionId string, resourceGroupName string, simGroupName string, simName string) SimId

NewSimID returns a new SimId struct

func ParseSimID 

func ParseSimID(input string) (*SimId, error)

ParseSimID parses 'input' into a SimId

func ParseSimIDInsensitively 

func ParseSimIDInsensitively(input string) (*SimId, error)

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

func (*SimId) FromParseResult 

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

func (SimId) ID 

func (id SimId) ID() string

ID returns the formatted Sim ID

func (SimId) Segments 

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

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

func (SimId) String 

func (id SimId) String() string

String returns a human-readable description of this Sim ID

type SimPolicyResourceId 

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

type SimPropertiesFormat 

type SimPropertiesFormat struct {
	AuthenticationKey                     *string                           `json:"authenticationKey,omitempty"`
	DeviceType                            *string                           `json:"deviceType,omitempty"`
	IntegratedCircuitCardIdentifier       *string                           `json:"integratedCircuitCardIdentifier,omitempty"`
	InternationalMobileSubscriberIdentity string                            `json:"internationalMobileSubscriberIdentity"`
	OperatorKeyCode                       *string                           `json:"operatorKeyCode,omitempty"`
	ProvisioningState                     *ProvisioningState                `json:"provisioningState,omitempty"`
	SimPolicy                             *SimPolicyResourceId              `json:"simPolicy,omitempty"`
	SimState                              *SimState                         `json:"simState,omitempty"`
	SiteProvisioningState                 *map[string]SiteProvisioningState `json:"siteProvisioningState,omitempty"`
	StaticIPConfiguration                 *[]SimStaticIPProperties          `json:"staticIpConfiguration,omitempty"`
	VendorKeyFingerprint                  *string                           `json:"vendorKeyFingerprint,omitempty"`
	VendorName                            *string                           `json:"vendorName,omitempty"`
}

type SimState 

type SimState string
const (
	SimStateDisabled SimState = "Disabled"
	SimStateEnabled  SimState = "Enabled"
	SimStateInvalid  SimState = "Invalid"
)

func (*SimState) UnmarshalJSON 

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

type SimStaticIPProperties 

type SimStaticIPProperties struct {
	AttachedDataNetwork *AttachedDataNetworkResourceId `json:"attachedDataNetwork,omitempty"`
	Slice               *SliceResourceId               `json:"slice,omitempty"`
	StaticIP            *SimStaticIPPropertiesStaticIP `json:"staticIp,omitempty"`
}

type SimStaticIPPropertiesStaticIP 

type SimStaticIPPropertiesStaticIP struct {
	IPv4Address *string `json:"ipv4Address,omitempty"`
}

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 SliceResourceId 

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

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.