mobilenetworks

package
v0.20240617.1095803 Latest Latest
Warning

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

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

README

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

The mobilenetworks 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-04-01/mobilenetworks"

Client Initialization

client := mobilenetworks.NewMobileNetworksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MobileNetworksClient.ListByResourceGroup

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

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

Example Usage: MobileNetworksClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: MobileNetworksClient.ListSimGroups

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

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

func PossibleValuesForProvisioningState() []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 HomeNetworkPublicKey

type HomeNetworkPublicKey struct {
	Id  int64   `json:"id"`
	Url *string `json:"url,omitempty"`
}

type KeyVaultKey

type KeyVaultKey struct {
	KeyUrl *string `json:"keyUrl,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MobileNetwork
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MobileNetwork
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MobileNetwork
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MobileNetwork
}

type ListSimGroupsCompleteResult

type ListSimGroupsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SimGroup
}

type ListSimGroupsOperationResponse

type ListSimGroupsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SimGroup
}

type MobileNetwork

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

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 MobileNetworkOperationPredicate

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

func (MobileNetworkOperationPredicate) Matches

type MobileNetworkPropertiesFormat

type MobileNetworkPropertiesFormat struct {
	ProvisioningState                 *ProvisioningState         `json:"provisioningState,omitempty"`
	PublicLandMobileNetworkIdentifier PlmnId                     `json:"publicLandMobileNetworkIdentifier"`
	PublicLandMobileNetworks          *[]PublicLandMobileNetwork `json:"publicLandMobileNetworks,omitempty"`
	ServiceKey                        *string                    `json:"serviceKey,omitempty"`
}

type MobileNetworkResourceId

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

type MobileNetworksClient

type MobileNetworksClient struct {
	Client *resourcemanager.Client
}

func NewMobileNetworksClientWithBaseURI

func NewMobileNetworksClientWithBaseURI(sdkApi sdkEnv.Api) (*MobileNetworksClient, error)

func (MobileNetworksClient) ListByResourceGroup

ListByResourceGroup ...

func (MobileNetworksClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (MobileNetworksClient) ListByResourceGroupCompleteMatchingPredicate

func (c MobileNetworksClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate MobileNetworkOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MobileNetworksClient) ListBySubscription

ListBySubscription ...

func (MobileNetworksClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (MobileNetworksClient) ListBySubscriptionCompleteMatchingPredicate

func (c MobileNetworksClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate MobileNetworkOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MobileNetworksClient) ListSimGroups

ListSimGroups ...

func (MobileNetworksClient) ListSimGroupsComplete

ListSimGroupsComplete retrieves all the results into a single object

func (MobileNetworksClient) ListSimGroupsCompleteMatchingPredicate

func (c MobileNetworksClient) ListSimGroupsCompleteMatchingPredicate(ctx context.Context, id MobileNetworkId, predicate SimGroupOperationPredicate) (result ListSimGroupsCompleteResult, err error)

ListSimGroupsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PlmnId

type PlmnId struct {
	Mcc string `json:"mcc"`
	Mnc string `json:"mnc"`
}

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 PublicLandMobileNetwork

type PublicLandMobileNetwork struct {
	HomeNetworkPublicKeys *PublicLandMobileNetworkHomeNetworkPublicKeys `json:"homeNetworkPublicKeys,omitempty"`
	Mcc                   string                                        `json:"mcc"`
	Mnc                   string                                        `json:"mnc"`
}

type PublicLandMobileNetworkHomeNetworkPublicKeys

type PublicLandMobileNetworkHomeNetworkPublicKeys struct {
	ProfileA *[]HomeNetworkPublicKey `json:"profileA,omitempty"`
	ProfileB *[]HomeNetworkPublicKey `json:"profileB,omitempty"`
}

type SimGroup

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

type SimGroupOperationPredicate

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

func (SimGroupOperationPredicate) Matches

func (p SimGroupOperationPredicate) Matches(input SimGroup) bool

type SimGroupPropertiesFormat

type SimGroupPropertiesFormat struct {
	EncryptionKey     *KeyVaultKey             `json:"encryptionKey,omitempty"`
	MobileNetwork     *MobileNetworkResourceId `json:"mobileNetwork,omitempty"`
	ProvisioningState *ProvisioningState       `json:"provisioningState,omitempty"`
}

Jump to

Keyboard shortcuts

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