packetcorecontrolplaneversion

README

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

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

Client Initialization

client := packetcorecontrolplaneversion.NewPacketCoreControlPlaneVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PacketCoreControlPlaneVersionClient.Get

ctx := context.TODO()
id := packetcorecontrolplaneversion.NewPacketCoreControlPlaneVersionID("packetCoreControlPlaneVersionValue")

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: PacketCoreControlPlaneVersionClient.List

ctx := context.TODO()


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

Documentation

Index

• func PossibleValuesForObsoleteVersion() []string
• func PossibleValuesForPlatformType() []string
• func PossibleValuesForProvisioningState() []string
• func PossibleValuesForRecommendedVersion() []string
• func PossibleValuesForVersionState() []string
• func ValidatePacketCoreControlPlaneVersionID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type ObsoleteVersion
  • func (s *ObsoleteVersion) UnmarshalJSON(bytes []byte) error
• type PacketCoreControlPlaneVersion
• type PacketCoreControlPlaneVersionClient
  • func NewPacketCoreControlPlaneVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreControlPlaneVersionClient, error)
  • func (c PacketCoreControlPlaneVersionClient) Get(ctx context.Context, id PacketCoreControlPlaneVersionId) (result GetOperationResponse, err error)
  • func (c PacketCoreControlPlaneVersionClient) List(ctx context.Context) (result ListOperationResponse, err error)
  • func (c PacketCoreControlPlaneVersionClient) ListComplete(ctx context.Context) (ListCompleteResult, error)
  • func (c PacketCoreControlPlaneVersionClient) ListCompleteMatchingPredicate(ctx context.Context, predicate PacketCoreControlPlaneVersionOperationPredicate) (result ListCompleteResult, err error)
• type PacketCoreControlPlaneVersionId
  • func NewPacketCoreControlPlaneVersionID(packetCoreControlPlaneVersionName string) PacketCoreControlPlaneVersionId
  • func ParsePacketCoreControlPlaneVersionID(input string) (*PacketCoreControlPlaneVersionId, error)
  • func ParsePacketCoreControlPlaneVersionIDInsensitively(input string) (*PacketCoreControlPlaneVersionId, error)
  • func (id *PacketCoreControlPlaneVersionId) FromParseResult(input resourceids.ParseResult) error
  • func (id PacketCoreControlPlaneVersionId) ID() string
  • func (id PacketCoreControlPlaneVersionId) Segments() []resourceids.Segment
  • func (id PacketCoreControlPlaneVersionId) String() string
• type PacketCoreControlPlaneVersionOperationPredicate
  • func (p PacketCoreControlPlaneVersionOperationPredicate) Matches(input PacketCoreControlPlaneVersion) bool
• type PacketCoreControlPlaneVersionPropertiesFormat
• type Platform
• type PlatformType
  • func (s *PlatformType) UnmarshalJSON(bytes []byte) error
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type RecommendedVersion
  • func (s *RecommendedVersion) UnmarshalJSON(bytes []byte) error
• type VersionState
  • func (s *VersionState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForObsoleteVersion

func PossibleValuesForObsoleteVersion() []string

func PossibleValuesForPlatformType

func PossibleValuesForPlatformType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRecommendedVersion

func PossibleValuesForRecommendedVersion() []string

func PossibleValuesForVersionState

func PossibleValuesForVersionState() []string

func ValidatePacketCoreControlPlaneVersionID

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

ValidatePacketCoreControlPlaneVersionID checks that 'input' can be parsed as a Packet Core Control Plane Version ID

Types

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PacketCoreControlPlaneVersion
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PacketCoreControlPlaneVersion
}

type ObsoleteVersion

type ObsoleteVersion string

const (
	ObsoleteVersionNotObsolete ObsoleteVersion = "NotObsolete"
	ObsoleteVersionObsolete    ObsoleteVersion = "Obsolete"
)

func (*ObsoleteVersion) UnmarshalJSON

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

type PacketCoreControlPlaneVersion

type PacketCoreControlPlaneVersion struct {
	Id         *string                                       `json:"id,omitempty"`
	Name       *string                                       `json:"name,omitempty"`
	Properties PacketCoreControlPlaneVersionPropertiesFormat `json:"properties"`
	SystemData *systemdata.SystemData                        `json:"systemData,omitempty"`
	Type       *string                                       `json:"type,omitempty"`
}

type PacketCoreControlPlaneVersionClient

type PacketCoreControlPlaneVersionClient struct {
	Client *resourcemanager.Client
}

func NewPacketCoreControlPlaneVersionClientWithBaseURI

func NewPacketCoreControlPlaneVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreControlPlaneVersionClient, error)

func (PacketCoreControlPlaneVersionClient) Get

func (c PacketCoreControlPlaneVersionClient) Get(ctx context.Context, id PacketCoreControlPlaneVersionId) (result GetOperationResponse, err error)

Get ...

func (PacketCoreControlPlaneVersionClient) List

func (c PacketCoreControlPlaneVersionClient) List(ctx context.Context) (result ListOperationResponse, err error)

List ...

func (PacketCoreControlPlaneVersionClient) ListComplete

func (c PacketCoreControlPlaneVersionClient) ListComplete(ctx context.Context) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PacketCoreControlPlaneVersionClient) ListCompleteMatchingPredicate

func (c PacketCoreControlPlaneVersionClient) ListCompleteMatchingPredicate(ctx context.Context, predicate PacketCoreControlPlaneVersionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PacketCoreControlPlaneVersionId

type PacketCoreControlPlaneVersionId struct {
	PacketCoreControlPlaneVersionName string
}

PacketCoreControlPlaneVersionId is a struct representing the Resource ID for a Packet Core Control Plane Version

func NewPacketCoreControlPlaneVersionID

func NewPacketCoreControlPlaneVersionID(packetCoreControlPlaneVersionName string) PacketCoreControlPlaneVersionId

NewPacketCoreControlPlaneVersionID returns a new PacketCoreControlPlaneVersionId struct

func ParsePacketCoreControlPlaneVersionID

func ParsePacketCoreControlPlaneVersionID(input string) (*PacketCoreControlPlaneVersionId, error)

ParsePacketCoreControlPlaneVersionID parses 'input' into a PacketCoreControlPlaneVersionId

func ParsePacketCoreControlPlaneVersionIDInsensitively

func ParsePacketCoreControlPlaneVersionIDInsensitively(input string) (*PacketCoreControlPlaneVersionId, error)

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

func (*PacketCoreControlPlaneVersionId) FromParseResult

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

func (PacketCoreControlPlaneVersionId) ID

func (id PacketCoreControlPlaneVersionId) ID() string

ID returns the formatted Packet Core Control Plane Version ID

func (PacketCoreControlPlaneVersionId) Segments

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

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

func (PacketCoreControlPlaneVersionId) String

func (id PacketCoreControlPlaneVersionId) String() string

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

type PacketCoreControlPlaneVersionOperationPredicate

type PacketCoreControlPlaneVersionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PacketCoreControlPlaneVersionOperationPredicate) Matches

func (p PacketCoreControlPlaneVersionOperationPredicate) Matches(input PacketCoreControlPlaneVersion) bool

type PacketCoreControlPlaneVersionPropertiesFormat

type PacketCoreControlPlaneVersionPropertiesFormat struct {
	Platforms         *[]Platform        `json:"platforms,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type Platform

type Platform struct {
	MaximumPlatformSoftwareVersion *string             `json:"maximumPlatformSoftwareVersion,omitempty"`
	MinimumPlatformSoftwareVersion *string             `json:"minimumPlatformSoftwareVersion,omitempty"`
	ObsoleteVersion                *ObsoleteVersion    `json:"obsoleteVersion,omitempty"`
	PlatformType                   *PlatformType       `json:"platformType,omitempty"`
	RecommendedVersion             *RecommendedVersion `json:"recommendedVersion,omitempty"`
	VersionState                   *VersionState       `json:"versionState,omitempty"`
}

type PlatformType

type PlatformType string

const (
	PlatformTypeAKSNegativeHCI                              PlatformType = "AKS-HCI"
	PlatformTypeThreePNegativeAZURENegativeSTACKNegativeHCI PlatformType = "3P-AZURE-STACK-HCI"
)

func (*PlatformType) UnmarshalJSON

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

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 RecommendedVersion

type RecommendedVersion string

const (
	RecommendedVersionNotRecommended RecommendedVersion = "NotRecommended"
	RecommendedVersionRecommended    RecommendedVersion = "Recommended"
)

func (*RecommendedVersion) UnmarshalJSON

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

type VersionState

type VersionState string

const (
	VersionStateActive           VersionState = "Active"
	VersionStateDeprecated       VersionState = "Deprecated"
	VersionStatePreview          VersionState = "Preview"
	VersionStateUnknown          VersionState = "Unknown"
	VersionStateValidating       VersionState = "Validating"
	VersionStateValidationFailed VersionState = "ValidationFailed"
)

func (*VersionState) UnmarshalJSON

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