sims

package
v0.20240606.1065251 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

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

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

Client Initialization

client := sims.NewSIMsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMsClient.BulkDelete

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

payload := sims.SimDeleteList{
	// ...
}


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

Example Usage: SIMsClient.BulkUpload

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

payload := sims.SimUploadList{
	// ...
}


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

Example Usage: SIMsClient.BulkUploadEncrypted

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

payload := sims.EncryptedSimUploadList{
	// ...
}


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

Example Usage: SIMsClient.Clone

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

payload := sims.SimClone{
	// ...
}


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

Example Usage: SIMsClient.ListByGroup

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

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

Example Usage: SIMsClient.Move

ctx := context.TODO()
id := sims.NewSimGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "simGroupValue")

payload := sims.SimMove{
	// ...
}


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

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 ValidateSimGroupID 

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

ValidateSimGroupID checks that 'input' can be parsed as a Sim Group ID

Types

type AsyncOperationStatus 

type AsyncOperationStatus struct {
	EndTime         *string      `json:"endTime,omitempty"`
	Error           *ErrorDetail `json:"error,omitempty"`
	Id              *string      `json:"id,omitempty"`
	Name            *string      `json:"name,omitempty"`
	PercentComplete *float64     `json:"percentComplete,omitempty"`
	Properties      *interface{} `json:"properties,omitempty"`
	ResourceId      *string      `json:"resourceId,omitempty"`
	StartTime       *string      `json:"startTime,omitempty"`
	Status          string       `json:"status"`
}

func (*AsyncOperationStatus) GetEndTimeAsTime 

func (o *AsyncOperationStatus) GetEndTimeAsTime() (*time.Time, error)

func (*AsyncOperationStatus) GetStartTimeAsTime 

func (o *AsyncOperationStatus) GetStartTimeAsTime() (*time.Time, error)

func (*AsyncOperationStatus) SetEndTimeAsTime 

func (o *AsyncOperationStatus) SetEndTimeAsTime(input time.Time)

func (*AsyncOperationStatus) SetStartTimeAsTime 

func (o *AsyncOperationStatus) SetStartTimeAsTime(input time.Time)

type AttachedDataNetworkResourceId 

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

type BulkDeleteOperationResponse 

type BulkDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationStatus
}

type BulkUploadEncryptedOperationResponse 

type BulkUploadEncryptedOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationStatus
}

type BulkUploadOperationResponse 

type BulkUploadOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationStatus
}

type CloneOperationResponse 

type CloneOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationStatus
}

type EncryptedSimPropertiesFormat 

type EncryptedSimPropertiesFormat struct {
	DeviceType                            *string                           `json:"deviceType,omitempty"`
	EncryptedCredentials                  *string                           `json:"encryptedCredentials,omitempty"`
	IntegratedCircuitCardIdentifier       *string                           `json:"integratedCircuitCardIdentifier,omitempty"`
	InternationalMobileSubscriberIdentity string                            `json:"internationalMobileSubscriberIdentity"`
	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 EncryptedSimUploadList 

type EncryptedSimUploadList struct {
	AzureKeyIdentifier    int64                           `json:"azureKeyIdentifier"`
	EncryptedTransportKey string                          `json:"encryptedTransportKey"`
	SignedTransportKey    string                          `json:"signedTransportKey"`
	Sims                  []SimNameAndEncryptedProperties `json:"sims"`
	VendorKeyFingerprint  string                          `json:"vendorKeyFingerprint"`
	Version               int64                           `json:"version"`
}

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail 

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type ListByGroupCompleteResult 

type ListByGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Sim
}

type ListByGroupOperationResponse 

type ListByGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Sim
}

type MoveOperationResponse 

type MoveOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AsyncOperationStatus
}

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 SIMsClient 

type SIMsClient struct {
	Client *resourcemanager.Client
}

func NewSIMsClientWithBaseURI 

func NewSIMsClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMsClient, error)

func (SIMsClient) BulkDelete 

func (c SIMsClient) BulkDelete(ctx context.Context, id SimGroupId, input SimDeleteList) (result BulkDeleteOperationResponse, err error)

BulkDelete ...

func (SIMsClient) BulkDeleteThenPoll 

func (c SIMsClient) BulkDeleteThenPoll(ctx context.Context, id SimGroupId, input SimDeleteList) error

BulkDeleteThenPoll performs BulkDelete then polls until it's completed

func (SIMsClient) BulkUpload 

func (c SIMsClient) BulkUpload(ctx context.Context, id SimGroupId, input SimUploadList) (result BulkUploadOperationResponse, err error)

BulkUpload ...

func (SIMsClient) BulkUploadEncrypted 

func (c SIMsClient) BulkUploadEncrypted(ctx context.Context, id SimGroupId, input EncryptedSimUploadList) (result BulkUploadEncryptedOperationResponse, err error)

BulkUploadEncrypted ...

func (SIMsClient) BulkUploadEncryptedThenPoll 

func (c SIMsClient) BulkUploadEncryptedThenPoll(ctx context.Context, id SimGroupId, input EncryptedSimUploadList) error

BulkUploadEncryptedThenPoll performs BulkUploadEncrypted then polls until it's completed

func (SIMsClient) BulkUploadThenPoll 

func (c SIMsClient) BulkUploadThenPoll(ctx context.Context, id SimGroupId, input SimUploadList) error

BulkUploadThenPoll performs BulkUpload then polls until it's completed

func (SIMsClient) Clone 

func (c SIMsClient) Clone(ctx context.Context, id SimGroupId, input SimClone) (result CloneOperationResponse, err error)

Clone ...

func (SIMsClient) CloneThenPoll 

func (c SIMsClient) CloneThenPoll(ctx context.Context, id SimGroupId, input SimClone) error

CloneThenPoll performs Clone then polls until it's completed

func (SIMsClient) ListByGroup 

func (c SIMsClient) ListByGroup(ctx context.Context, id SimGroupId) (result ListByGroupOperationResponse, err error)

ListByGroup ...

func (SIMsClient) ListByGroupComplete 

func (c SIMsClient) ListByGroupComplete(ctx context.Context, id SimGroupId) (ListByGroupCompleteResult, error)

ListByGroupComplete retrieves all the results into a single object

func (SIMsClient) ListByGroupCompleteMatchingPredicate 

func (c SIMsClient) ListByGroupCompleteMatchingPredicate(ctx context.Context, id SimGroupId, predicate SimOperationPredicate) (result ListByGroupCompleteResult, err error)

ListByGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SIMsClient) Move 

func (c SIMsClient) Move(ctx context.Context, id SimGroupId, input SimMove) (result MoveOperationResponse, err error)

Move ...

func (SIMsClient) MoveThenPoll 

func (c SIMsClient) MoveThenPoll(ctx context.Context, id SimGroupId, input SimMove) error

MoveThenPoll performs Move then polls until it's completed

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 SimClone 

type SimClone struct {
	Sims             *[]string           `json:"sims,omitempty"`
	TargetSimGroupId *SimGroupResourceId `json:"targetSimGroupId,omitempty"`
}

type SimDeleteList 

type SimDeleteList struct {
	Sims []string `json:"sims"`
}

type SimGroupId 

type SimGroupId struct {
	SubscriptionId    string
	ResourceGroupName string
	SimGroupName      string
}

SimGroupId is a struct representing the Resource ID for a Sim Group

func NewSimGroupID 

func NewSimGroupID(subscriptionId string, resourceGroupName string, simGroupName string) SimGroupId

NewSimGroupID returns a new SimGroupId struct

func ParseSimGroupID 

func ParseSimGroupID(input string) (*SimGroupId, error)

ParseSimGroupID parses 'input' into a SimGroupId

func ParseSimGroupIDInsensitively 

func ParseSimGroupIDInsensitively(input string) (*SimGroupId, error)

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

func (*SimGroupId) FromParseResult 

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

func (SimGroupId) ID 

func (id SimGroupId) ID() string

ID returns the formatted Sim Group ID

func (SimGroupId) Segments 

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

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

func (SimGroupId) String 

func (id SimGroupId) String() string

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

type SimGroupResourceId 

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

type SimMove 

type SimMove struct {
	Sims             *[]string           `json:"sims,omitempty"`
	TargetSimGroupId *SimGroupResourceId `json:"targetSimGroupId,omitempty"`
}

type SimNameAndEncryptedProperties 

type SimNameAndEncryptedProperties struct {
	Name       string                       `json:"name"`
	Properties EncryptedSimPropertiesFormat `json:"properties"`
}

type SimNameAndProperties 

type SimNameAndProperties struct {
	Name       string              `json:"name"`
	Properties SimPropertiesFormat `json:"properties"`
}

type SimOperationPredicate 

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

func (SimOperationPredicate) Matches 

func (p SimOperationPredicate) Matches(input Sim) bool

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 SimUploadList 

type SimUploadList struct {
	Sims []SimNameAndProperties `json:"sims"`
}

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.