site

README

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

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

Client Initialization

client := site.NewSiteClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SiteClient.CreateOrUpdate

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

payload := site.Site{
	// ...
}


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

Example Usage: SiteClient.Delete

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

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

Example Usage: SiteClient.DeletePacketCore

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

payload := site.SiteDeletePacketCore{
	// ...
}


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

Example Usage: SiteClient.Get

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

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

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

payload := site.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 ValidateSiteID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type DeletePacketCoreOperationResponse
• type GetOperationResponse
• type PacketCoreControlPlaneResourceId
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type Site
• type SiteClient
  • func NewSiteClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteClient, error)
  • func (c SiteClient) CreateOrUpdate(ctx context.Context, id SiteId, input Site) (result CreateOrUpdateOperationResponse, err error)
  • func (c SiteClient) CreateOrUpdateThenPoll(ctx context.Context, id SiteId, input Site) error
  • func (c SiteClient) Delete(ctx context.Context, id SiteId) (result DeleteOperationResponse, err error)
  • func (c SiteClient) DeletePacketCore(ctx context.Context, id SiteId, input SiteDeletePacketCore) (result DeletePacketCoreOperationResponse, err error)
  • func (c SiteClient) DeletePacketCoreThenPoll(ctx context.Context, id SiteId, input SiteDeletePacketCore) error
  • func (c SiteClient) DeleteThenPoll(ctx context.Context, id SiteId) error
  • func (c SiteClient) Get(ctx context.Context, id SiteId) (result GetOperationResponse, err error)
  • func (c SiteClient) UpdateTags(ctx context.Context, id SiteId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type SiteDeletePacketCore
• type SiteId
  • func NewSiteID(subscriptionId string, resourceGroupName string, mobileNetworkName string, ...) SiteId
  • func ParseSiteID(input string) (*SiteId, error)
  • func ParseSiteIDInsensitively(input string) (*SiteId, error)
  • func (id *SiteId) FromParseResult(input resourceids.ParseResult) error
  • func (id SiteId) ID() string
  • func (id SiteId) Segments() []resourceids.Segment
  • func (id SiteId) String() string
• type SitePropertiesFormat
• type SubResource
• type TagsObject
• type UpdateTagsOperationResponse

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateSiteID

func ValidateSiteID(input interface{}, key string) (warnings []string, errors []error)

ValidateSiteID checks that 'input' can be parsed as a Site ID

Types

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeletePacketCoreOperationResponse

type DeletePacketCoreOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Site
}

type PacketCoreControlPlaneResourceId

type PacketCoreControlPlaneResourceId 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 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 SiteClient

type SiteClient struct {
	Client *resourcemanager.Client
}

func NewSiteClientWithBaseURI

func NewSiteClientWithBaseURI(sdkApi sdkEnv.Api) (*SiteClient, error)

func (SiteClient) CreateOrUpdate

func (c SiteClient) CreateOrUpdate(ctx context.Context, id SiteId, input Site) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SiteClient) CreateOrUpdateThenPoll

func (c SiteClient) CreateOrUpdateThenPoll(ctx context.Context, id SiteId, input Site) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (SiteClient) Delete

func (c SiteClient) Delete(ctx context.Context, id SiteId) (result DeleteOperationResponse, err error)

Delete ...

func (SiteClient) DeletePacketCore

func (c SiteClient) DeletePacketCore(ctx context.Context, id SiteId, input SiteDeletePacketCore) (result DeletePacketCoreOperationResponse, err error)

DeletePacketCore ...

func (SiteClient) DeletePacketCoreThenPoll

func (c SiteClient) DeletePacketCoreThenPoll(ctx context.Context, id SiteId, input SiteDeletePacketCore) error

DeletePacketCoreThenPoll performs DeletePacketCore then polls until it's completed

func (SiteClient) DeleteThenPoll

func (c SiteClient) DeleteThenPoll(ctx context.Context, id SiteId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SiteClient) Get

func (c SiteClient) Get(ctx context.Context, id SiteId) (result GetOperationResponse, err error)

Get ...

func (SiteClient) UpdateTags

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

UpdateTags ...

type SiteDeletePacketCore

type SiteDeletePacketCore struct {
	PacketCore *PacketCoreControlPlaneResourceId `json:"packetCore,omitempty"`
}

type SiteId

type SiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	MobileNetworkName string
	SiteName          string
}

SiteId is a struct representing the Resource ID for a Site

func NewSiteID

func NewSiteID(subscriptionId string, resourceGroupName string, mobileNetworkName string, siteName string) SiteId

NewSiteID returns a new SiteId struct

func ParseSiteID

func ParseSiteID(input string) (*SiteId, error)

ParseSiteID parses 'input' into a SiteId

func ParseSiteIDInsensitively

func ParseSiteIDInsensitively(input string) (*SiteId, error)

ParseSiteIDInsensitively parses 'input' case-insensitively into a SiteId note: this method should only be used for API response data and not user input

func (*SiteId) FromParseResult

func (id *SiteId) FromParseResult(input resourceids.ParseResult) error

func (SiteId) ID

func (id SiteId) ID() string

ID returns the formatted Site ID

func (SiteId) Segments

func (id SiteId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Site ID

func (SiteId) String

func (id SiteId) String() string

String returns a human-readable description of this Site ID

type SitePropertiesFormat

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

type SubResource

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

type TagsObject

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

type UpdateTagsOperationResponse

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