mobilenetworks

README

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

The mobilenetworks SDK allows for interaction with the Azure Resource Manager Service 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-02-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
}

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• type HomeNetworkPublicKey
• type ListByResourceGroupCompleteResult
• type ListByResourceGroupOperationResponse
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionOperationResponse
• type MobileNetwork
• type MobileNetworkOperationPredicate
  • func (p MobileNetworkOperationPredicate) Matches(input MobileNetwork) bool
• type MobileNetworkPropertiesFormat
• type MobileNetworksClient
  • func NewMobileNetworksClientWithBaseURI(sdkApi sdkEnv.Api) (*MobileNetworksClient, error)
  • func (c MobileNetworksClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
  • func (c MobileNetworksClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
  • func (c MobileNetworksClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
  • func (c MobileNetworksClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c MobileNetworksClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c MobileNetworksClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
• type PlmnId
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type PublicLandMobileNetwork
• type PublicLandMobileNetworkHomeNetworkPublicKeys

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

Types

type HomeNetworkPublicKey

type HomeNetworkPublicKey struct {
	Id  int64   `json:"id"`
	Url *string `json:"url,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 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 MobileNetworkOperationPredicate

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

func (MobileNetworkOperationPredicate) Matches

func (p MobileNetworkOperationPredicate) Matches(input MobileNetwork) bool

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 MobileNetworksClient

type MobileNetworksClient struct {
	Client *resourcemanager.Client
}

func NewMobileNetworksClientWithBaseURI

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

func (MobileNetworksClient) ListByResourceGroup

func (c MobileNetworksClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (MobileNetworksClient) ListByResourceGroupComplete

func (c MobileNetworksClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

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

func (c MobileNetworksClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (MobileNetworksClient) ListBySubscriptionComplete

func (c MobileNetworksClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

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

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