sites

README

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

The sites 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-sdk/resource-manager/mobilenetwork/2024-04-01/sites"

Client Initialization

client := sites.NewSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SitesClient.ListByMobileNetwork

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

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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateMobileNetworkID(input interface{}, key string) (warnings []string, errors []error)
• type ListByMobileNetworkCompleteResult
• type ListByMobileNetworkCustomPager
  • func (p *ListByMobileNetworkCustomPager) NextPageLink() *odata.Link
• type ListByMobileNetworkOperationResponse
• 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 ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type Site
• type SiteOperationPredicate
  • func (p SiteOperationPredicate) Matches(input Site) bool
• type SitePropertiesFormat
• type SitesClient
  • func NewSitesClientWithBaseURI(sdkApi sdkEnv.Api) (*SitesClient, error)
  • func (c SitesClient) ListByMobileNetwork(ctx context.Context, id MobileNetworkId) (result ListByMobileNetworkOperationResponse, err error)
  • func (c SitesClient) ListByMobileNetworkComplete(ctx context.Context, id MobileNetworkId) (ListByMobileNetworkCompleteResult, error)
  • func (c SitesClient) ListByMobileNetworkCompleteMatchingPredicate(ctx context.Context, id MobileNetworkId, predicate SiteOperationPredicate) (result ListByMobileNetworkCompleteResult, err error)
• type SubResource

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 ListByMobileNetworkCompleteResult

type ListByMobileNetworkCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Site
}

type ListByMobileNetworkCustomPager

type ListByMobileNetworkCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByMobileNetworkCustomPager) NextPageLink

func (p *ListByMobileNetworkCustomPager) NextPageLink() *odata.Link

type ListByMobileNetworkOperationResponse

type ListByMobileNetworkOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Site
}

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 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 Site

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

type SiteOperationPredicate

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

func (SiteOperationPredicate) Matches

func (p SiteOperationPredicate) Matches(input Site) bool

type SitePropertiesFormat

type SitePropertiesFormat struct {
	NetworkFunctions  *[]SubResource     `json:"networkFunctions,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type SitesClient

type SitesClient struct {
	Client *resourcemanager.Client
}

func NewSitesClientWithBaseURI

func NewSitesClientWithBaseURI(sdkApi sdkEnv.Api) (*SitesClient, error)

func (SitesClient) ListByMobileNetwork

func (c SitesClient) ListByMobileNetwork(ctx context.Context, id MobileNetworkId) (result ListByMobileNetworkOperationResponse, err error)

ListByMobileNetwork ...

func (SitesClient) ListByMobileNetworkComplete

func (c SitesClient) ListByMobileNetworkComplete(ctx context.Context, id MobileNetworkId) (ListByMobileNetworkCompleteResult, error)

ListByMobileNetworkComplete retrieves all the results into a single object

func (SitesClient) ListByMobileNetworkCompleteMatchingPredicate

func (c SitesClient) ListByMobileNetworkCompleteMatchingPredicate(ctx context.Context, id MobileNetworkId, predicate SiteOperationPredicate) (result ListByMobileNetworkCompleteResult, err error)

ListByMobileNetworkCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SubResource

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