mobilenetwork

README

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

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

Client Initialization

client := mobilenetwork.NewMobileNetworkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MobileNetworkClient.CreateOrUpdate

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

payload := mobilenetwork.MobileNetwork{
	// ...
}


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

Example Usage: MobileNetworkClient.Delete

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

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

Example Usage: MobileNetworkClient.Get

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

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
}

Example Usage: MobileNetworkClient.UpdateTags

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

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


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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateMobileNetworkID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type MobileNetwork
• type MobileNetworkClient
  • func NewMobileNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*MobileNetworkClient, error)
  • func (c MobileNetworkClient) CreateOrUpdate(ctx context.Context, id MobileNetworkId, input MobileNetwork) (result CreateOrUpdateOperationResponse, err error)
  • func (c MobileNetworkClient) CreateOrUpdateThenPoll(ctx context.Context, id MobileNetworkId, input MobileNetwork) error
  • func (c MobileNetworkClient) Delete(ctx context.Context, id MobileNetworkId) (result DeleteOperationResponse, err error)
  • func (c MobileNetworkClient) DeleteThenPoll(ctx context.Context, id MobileNetworkId) error
  • func (c MobileNetworkClient) Get(ctx context.Context, id MobileNetworkId) (result GetOperationResponse, err error)
  • func (c MobileNetworkClient) UpdateTags(ctx context.Context, id MobileNetworkId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type MobileNetworkId
  • func NewMobileNetworkID(subscriptionId string, resourceGroupName string, mobileNetworkName string) MobileNetworkId
  • func ParseMobileNetworkID(input string) (*MobileNetworkId, error)
  • func ParseMobileNetworkIDInsensitively(input string) (*MobileNetworkId, error)
  • func (id *MobileNetworkId) FromParseResult(input resourceids.ParseResult) error
  • func (id MobileNetworkId) ID() string
  • func (id MobileNetworkId) Segments() []resourceids.Segment
  • func (id MobileNetworkId) String() string
• type MobileNetworkPropertiesFormat
• type PlmnId
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TagsObject
• type UpdateTagsOperationResponse

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 CreateOrUpdateOperationResponse

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

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        *MobileNetwork
}

type MobileNetwork

type MobileNetwork struct {
	Id         *string                       `json:"id,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 MobileNetworkClient

type MobileNetworkClient struct {
	Client *resourcemanager.Client
}

func NewMobileNetworkClientWithBaseURI

func NewMobileNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*MobileNetworkClient, error)

func (MobileNetworkClient) CreateOrUpdate

func (c MobileNetworkClient) CreateOrUpdate(ctx context.Context, id MobileNetworkId, input MobileNetwork) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MobileNetworkClient) CreateOrUpdateThenPoll

func (c MobileNetworkClient) CreateOrUpdateThenPoll(ctx context.Context, id MobileNetworkId, input MobileNetwork) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (MobileNetworkClient) Delete

func (c MobileNetworkClient) Delete(ctx context.Context, id MobileNetworkId) (result DeleteOperationResponse, err error)

Delete ...

func (MobileNetworkClient) DeleteThenPoll

func (c MobileNetworkClient) DeleteThenPoll(ctx context.Context, id MobileNetworkId) error

DeleteThenPoll performs Delete then polls until it's completed

func (MobileNetworkClient) Get

func (c MobileNetworkClient) Get(ctx context.Context, id MobileNetworkId) (result GetOperationResponse, err error)

Get ...

func (MobileNetworkClient) UpdateTags

func (c MobileNetworkClient) UpdateTags(ctx context.Context, id MobileNetworkId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

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 MobileNetworkPropertiesFormat

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

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 TagsObject

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MobileNetwork
}