packetcoredataplane

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2023-09-01/packetcoredataplane Documentation

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

Client Initialization

client := packetcoredataplane.NewPacketCoreDataPlaneClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PacketCoreDataPlaneClient.CreateOrUpdate

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

payload := packetcoredataplane.PacketCoreDataPlane{
	// ...
}


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

Example Usage: PacketCoreDataPlaneClient.Delete

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

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

Example Usage: PacketCoreDataPlaneClient.Get

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

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

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

payload := packetcoredataplane.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 ValidatePacketCoreDataPlaneID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type InterfaceProperties
• type PacketCoreDataPlane
• type PacketCoreDataPlaneClient
  • func NewPacketCoreDataPlaneClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreDataPlaneClient, error)
  • func (c PacketCoreDataPlaneClient) CreateOrUpdate(ctx context.Context, id PacketCoreDataPlaneId, input PacketCoreDataPlane) (result CreateOrUpdateOperationResponse, err error)
  • func (c PacketCoreDataPlaneClient) CreateOrUpdateThenPoll(ctx context.Context, id PacketCoreDataPlaneId, input PacketCoreDataPlane) error
  • func (c PacketCoreDataPlaneClient) Delete(ctx context.Context, id PacketCoreDataPlaneId) (result DeleteOperationResponse, err error)
  • func (c PacketCoreDataPlaneClient) DeleteThenPoll(ctx context.Context, id PacketCoreDataPlaneId) error
  • func (c PacketCoreDataPlaneClient) Get(ctx context.Context, id PacketCoreDataPlaneId) (result GetOperationResponse, err error)
  • func (c PacketCoreDataPlaneClient) UpdateTags(ctx context.Context, id PacketCoreDataPlaneId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type PacketCoreDataPlaneId
  • func NewPacketCoreDataPlaneID(subscriptionId string, resourceGroupName string, ...) PacketCoreDataPlaneId
  • func ParsePacketCoreDataPlaneID(input string) (*PacketCoreDataPlaneId, error)
  • func ParsePacketCoreDataPlaneIDInsensitively(input string) (*PacketCoreDataPlaneId, error)
  • func (id PacketCoreDataPlaneId) ID() string
  • func (id PacketCoreDataPlaneId) Segments() []resourceids.Segment
  • func (id PacketCoreDataPlaneId) String() string
• type PacketCoreDataPlanePropertiesFormat
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TagsObject
• type UpdateTagsOperationResponse

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidatePacketCoreDataPlaneID

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

ValidatePacketCoreDataPlaneID checks that 'input' can be parsed as a Packet Core Data Plane ID

Types

type CreateOrUpdateOperationResponse

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

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

type InterfaceProperties

type InterfaceProperties struct {
	IPv4Address *string `json:"ipv4Address,omitempty"`
	IPv4Gateway *string `json:"ipv4Gateway,omitempty"`
	IPv4Subnet  *string `json:"ipv4Subnet,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type PacketCoreDataPlane

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

type PacketCoreDataPlaneClient

type PacketCoreDataPlaneClient struct {
	Client *resourcemanager.Client
}

func NewPacketCoreDataPlaneClientWithBaseURI

func NewPacketCoreDataPlaneClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreDataPlaneClient, error)

func (PacketCoreDataPlaneClient) CreateOrUpdate

func (c PacketCoreDataPlaneClient) CreateOrUpdate(ctx context.Context, id PacketCoreDataPlaneId, input PacketCoreDataPlane) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PacketCoreDataPlaneClient) CreateOrUpdateThenPoll

func (c PacketCoreDataPlaneClient) CreateOrUpdateThenPoll(ctx context.Context, id PacketCoreDataPlaneId, input PacketCoreDataPlane) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PacketCoreDataPlaneClient) Delete

func (c PacketCoreDataPlaneClient) Delete(ctx context.Context, id PacketCoreDataPlaneId) (result DeleteOperationResponse, err error)

Delete ...

func (PacketCoreDataPlaneClient) DeleteThenPoll

func (c PacketCoreDataPlaneClient) DeleteThenPoll(ctx context.Context, id PacketCoreDataPlaneId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PacketCoreDataPlaneClient) Get

func (c PacketCoreDataPlaneClient) Get(ctx context.Context, id PacketCoreDataPlaneId) (result GetOperationResponse, err error)

Get ...

func (PacketCoreDataPlaneClient) UpdateTags

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

UpdateTags ...

type PacketCoreDataPlaneId

type PacketCoreDataPlaneId struct {
	SubscriptionId             string
	ResourceGroupName          string
	PacketCoreControlPlaneName string
	PacketCoreDataPlaneName    string
}

PacketCoreDataPlaneId is a struct representing the Resource ID for a Packet Core Data Plane

func NewPacketCoreDataPlaneID

func NewPacketCoreDataPlaneID(subscriptionId string, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string) PacketCoreDataPlaneId

NewPacketCoreDataPlaneID returns a new PacketCoreDataPlaneId struct

func ParsePacketCoreDataPlaneID

func ParsePacketCoreDataPlaneID(input string) (*PacketCoreDataPlaneId, error)

ParsePacketCoreDataPlaneID parses 'input' into a PacketCoreDataPlaneId

func ParsePacketCoreDataPlaneIDInsensitively

func ParsePacketCoreDataPlaneIDInsensitively(input string) (*PacketCoreDataPlaneId, error)

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

func (PacketCoreDataPlaneId) ID

func (id PacketCoreDataPlaneId) ID() string

ID returns the formatted Packet Core Data Plane ID

func (PacketCoreDataPlaneId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Packet Core Data Plane ID

func (PacketCoreDataPlaneId) String

func (id PacketCoreDataPlaneId) String() string

String returns a human-readable description of this Packet Core Data Plane ID

type PacketCoreDataPlanePropertiesFormat

type PacketCoreDataPlanePropertiesFormat struct {
	ProvisioningState                   *ProvisioningState  `json:"provisioningState,omitempty"`
	UserPlaneAccessInterface            InterfaceProperties `json:"userPlaneAccessInterface"`
	UserPlaneAccessVirtualIPv4Addresses *[]string           `json:"userPlaneAccessVirtualIpv4Addresses,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        *PacketCoreDataPlane
}