attacheddatanetwork

package
v0.20240710.1114656 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := attacheddatanetwork.NewAttachedDataNetworkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AttachedDataNetworkClient.CreateOrUpdate

ctx := context.TODO()
id := attacheddatanetwork.NewAttachedDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "packetCoreControlPlaneValue", "packetCoreDataPlaneValue", "attachedDataNetworkValue")

payload := attacheddatanetwork.AttachedDataNetwork{
	// ...
}


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

Example Usage: AttachedDataNetworkClient.Delete

ctx := context.TODO()
id := attacheddatanetwork.NewAttachedDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "packetCoreControlPlaneValue", "packetCoreDataPlaneValue", "attachedDataNetworkValue")

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

Example Usage: AttachedDataNetworkClient.Get

ctx := context.TODO()
id := attacheddatanetwork.NewAttachedDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "packetCoreControlPlaneValue", "packetCoreDataPlaneValue", "attachedDataNetworkValue")

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

ctx := context.TODO()
id := attacheddatanetwork.NewAttachedDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "packetCoreControlPlaneValue", "packetCoreDataPlaneValue", "attachedDataNetworkValue")

payload := attacheddatanetwork.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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForNaptEnabled 

func PossibleValuesForNaptEnabled() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAttachedDataNetworkID 

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

ValidateAttachedDataNetworkID checks that 'input' can be parsed as a Attached Data Network ID

Types

type AttachedDataNetwork 

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

type AttachedDataNetworkClient 

type AttachedDataNetworkClient struct {
	Client *resourcemanager.Client
}

func NewAttachedDataNetworkClientWithBaseURI 

func NewAttachedDataNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*AttachedDataNetworkClient, error)

func (AttachedDataNetworkClient) CreateOrUpdate 

func (c AttachedDataNetworkClient) CreateOrUpdate(ctx context.Context, id AttachedDataNetworkId, input AttachedDataNetwork) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AttachedDataNetworkClient) CreateOrUpdateThenPoll 

func (c AttachedDataNetworkClient) CreateOrUpdateThenPoll(ctx context.Context, id AttachedDataNetworkId, input AttachedDataNetwork) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AttachedDataNetworkClient) Delete 

func (c AttachedDataNetworkClient) Delete(ctx context.Context, id AttachedDataNetworkId) (result DeleteOperationResponse, err error)

Delete ...

func (AttachedDataNetworkClient) DeleteThenPoll 

func (c AttachedDataNetworkClient) DeleteThenPoll(ctx context.Context, id AttachedDataNetworkId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AttachedDataNetworkClient) Get 

func (c AttachedDataNetworkClient) Get(ctx context.Context, id AttachedDataNetworkId) (result GetOperationResponse, err error)

Get ...

func (AttachedDataNetworkClient) UpdateTags 

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

UpdateTags ...

type AttachedDataNetworkId 

type AttachedDataNetworkId struct {
	SubscriptionId             string
	ResourceGroupName          string
	PacketCoreControlPlaneName string
	PacketCoreDataPlaneName    string
	AttachedDataNetworkName    string
}

AttachedDataNetworkId is a struct representing the Resource ID for a Attached Data Network

func NewAttachedDataNetworkID 

func NewAttachedDataNetworkID(subscriptionId string, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, attachedDataNetworkName string) AttachedDataNetworkId

NewAttachedDataNetworkID returns a new AttachedDataNetworkId struct

func ParseAttachedDataNetworkID 

func ParseAttachedDataNetworkID(input string) (*AttachedDataNetworkId, error)

ParseAttachedDataNetworkID parses 'input' into a AttachedDataNetworkId

func ParseAttachedDataNetworkIDInsensitively 

func ParseAttachedDataNetworkIDInsensitively(input string) (*AttachedDataNetworkId, error)

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

func (*AttachedDataNetworkId) FromParseResult 

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

func (AttachedDataNetworkId) ID 

func (id AttachedDataNetworkId) ID() string

ID returns the formatted Attached Data Network ID

func (AttachedDataNetworkId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Attached Data Network ID

func (AttachedDataNetworkId) String 

func (id AttachedDataNetworkId) String() string

String returns a human-readable description of this Attached Data Network ID

type AttachedDataNetworkPropertiesFormat 

type AttachedDataNetworkPropertiesFormat struct {
	DnsAddresses                         []string            `json:"dnsAddresses"`
	NaptConfiguration                    *NaptConfiguration  `json:"naptConfiguration,omitempty"`
	ProvisioningState                    *ProvisioningState  `json:"provisioningState,omitempty"`
	UserEquipmentAddressPoolPrefix       *[]string           `json:"userEquipmentAddressPoolPrefix,omitempty"`
	UserEquipmentStaticAddressPoolPrefix *[]string           `json:"userEquipmentStaticAddressPoolPrefix,omitempty"`
	UserPlaneDataInterface               InterfaceProperties `json:"userPlaneDataInterface"`
}

type CreateOrUpdateOperationResponse 

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

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

type InterfaceProperties 

type InterfaceProperties struct {
	BfdIPv4Endpoints *[]string `json:"bfdIpv4Endpoints,omitempty"`
	IPv4Address      *string   `json:"ipv4Address,omitempty"`
	IPv4AddressList  *[]string `json:"ipv4AddressList,omitempty"`
	IPv4Gateway      *string   `json:"ipv4Gateway,omitempty"`
	IPv4Subnet       *string   `json:"ipv4Subnet,omitempty"`
	Name             *string   `json:"name,omitempty"`
	VlanId           *int64    `json:"vlanId,omitempty"`
}

type NaptConfiguration 

type NaptConfiguration struct {
	Enabled           *NaptEnabled        `json:"enabled,omitempty"`
	PinholeLimits     *int64              `json:"pinholeLimits,omitempty"`
	PinholeTimeouts   *PinholeTimeouts    `json:"pinholeTimeouts,omitempty"`
	PortRange         *PortRange          `json:"portRange,omitempty"`
	PortReuseHoldTime *PortReuseHoldTimes `json:"portReuseHoldTime,omitempty"`
}

type NaptEnabled 

type NaptEnabled string
const (
	NaptEnabledDisabled NaptEnabled = "Disabled"
	NaptEnabledEnabled  NaptEnabled = "Enabled"
)

func (*NaptEnabled) UnmarshalJSON 

func (s *NaptEnabled) UnmarshalJSON(bytes []byte) error

type PinholeTimeouts 

type PinholeTimeouts struct {
	Icmp *int64 `json:"icmp,omitempty"`
	Tcp  *int64 `json:"tcp,omitempty"`
	Udp  *int64 `json:"udp,omitempty"`
}

type PortRange 

type PortRange struct {
	MaxPort *int64 `json:"maxPort,omitempty"`
	MinPort *int64 `json:"minPort,omitempty"`
}

type PortReuseHoldTimes 

type PortReuseHoldTimes struct {
	Tcp *int64 `json:"tcp,omitempty"`
	Udp *int64 `json:"udp,omitempty"`
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.