simgroups

README

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

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

Client Initialization

client := simgroups.NewSIMGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SIMGroupsClient.ListByResourceGroup

ctx := context.TODO()
id := simgroups.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: SIMGroupsClient.ListBySubscription

ctx := context.TODO()
id := simgroups.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 KeyVaultKey
• type ListByResourceGroupCompleteResult
• type ListByResourceGroupOperationResponse
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionOperationResponse
• type MobileNetworkResourceId
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type SIMGroupsClient
  • func NewSIMGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMGroupsClient, error)
  • func (c SIMGroupsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
  • func (c SIMGroupsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
  • func (c SIMGroupsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
  • func (c SIMGroupsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c SIMGroupsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c SIMGroupsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
• type SimGroup
• type SimGroupOperationPredicate
  • func (p SimGroupOperationPredicate) Matches(input SimGroup) bool
• type SimGroupPropertiesFormat

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

Types

type KeyVaultKey

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []SimGroup
}

type ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []SimGroup
}

type ListBySubscriptionOperationResponse

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

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 SIMGroupsClient

type SIMGroupsClient struct {
	Client *resourcemanager.Client
}

func NewSIMGroupsClientWithBaseURI

func NewSIMGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*SIMGroupsClient, error)

func (SIMGroupsClient) ListByResourceGroup

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

ListByResourceGroup ...

func (SIMGroupsClient) ListByResourceGroupComplete

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

ListByResourceGroupComplete retrieves all the results into a single object

func (SIMGroupsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SIMGroupsClient) ListBySubscription

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

ListBySubscription ...

func (SIMGroupsClient) ListBySubscriptionComplete

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

ListBySubscriptionComplete retrieves all the results into a single object

func (SIMGroupsClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

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