simgroup

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2022-11-01/simgroup Documentation

The simgroup SDK allows for interaction with the Azure Resource Manager Service mobilenetwork (API Version 2022-11-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/2022-11-01/simgroup"

Client Initialization

client := simgroup.NewSIMGroupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMGroupClient.CreateOrUpdate

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

payload := simgroup.SimGroup{
	// ...
}


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

Example Usage: SIMGroupClient.Delete

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

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

Example Usage: SIMGroupClient.Get

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

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: SIMGroupClient.UpdateTags

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

payload := simgroup.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 ValidateSimGroupID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type KeyVaultKey
• type MobileNetworkResourceId
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type SIMGroupClient
  • func NewSIMGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMGroupClient, error)
  • func (c SIMGroupClient) CreateOrUpdate(ctx context.Context, id SimGroupId, input SimGroup) (result CreateOrUpdateOperationResponse, err error)
  • func (c SIMGroupClient) CreateOrUpdateThenPoll(ctx context.Context, id SimGroupId, input SimGroup) error
  • func (c SIMGroupClient) Delete(ctx context.Context, id SimGroupId) (result DeleteOperationResponse, err error)
  • func (c SIMGroupClient) DeleteThenPoll(ctx context.Context, id SimGroupId) error
  • func (c SIMGroupClient) Get(ctx context.Context, id SimGroupId) (result GetOperationResponse, err error)
  • func (c SIMGroupClient) UpdateTags(ctx context.Context, id SimGroupId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type SimGroup
• type SimGroupId
  • func NewSimGroupID(subscriptionId string, resourceGroupName string, simGroupName string) SimGroupId
  • func ParseSimGroupID(input string) (*SimGroupId, error)
  • func ParseSimGroupIDInsensitively(input string) (*SimGroupId, error)
  • func (id *SimGroupId) FromParseResult(input resourceids.ParseResult) error
  • func (id SimGroupId) ID() string
  • func (id SimGroupId) Segments() []resourceids.Segment
  • func (id SimGroupId) String() string
• type SimGroupPropertiesFormat
• type TagsObject
• type UpdateTagsOperationResponse

Functions

func PossibleValuesForProvisioningState

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

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

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

type KeyVaultKey

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

type MobileNetworkResourceId

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

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 SIMGroupClient

type SIMGroupClient struct {
	Client *resourcemanager.Client
}

func NewSIMGroupClientWithBaseURI

func NewSIMGroupClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMGroupClient, error)

func (SIMGroupClient) CreateOrUpdate

func (c SIMGroupClient) CreateOrUpdate(ctx context.Context, id SimGroupId, input SimGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SIMGroupClient) CreateOrUpdateThenPoll

func (c SIMGroupClient) CreateOrUpdateThenPoll(ctx context.Context, id SimGroupId, input SimGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SIMGroupClient) Delete

func (c SIMGroupClient) Delete(ctx context.Context, id SimGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (SIMGroupClient) DeleteThenPoll

func (c SIMGroupClient) DeleteThenPoll(ctx context.Context, id SimGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SIMGroupClient) Get

func (c SIMGroupClient) Get(ctx context.Context, id SimGroupId) (result GetOperationResponse, err error)

Get ...

func (SIMGroupClient) UpdateTags

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

UpdateTags ...

type SimGroup

type SimGroup struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `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 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 SimGroupPropertiesFormat

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

type TagsObject

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

type UpdateTagsOperationResponse

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