packetcorecontrolplaneversion

package
v0.20230911.1163300 Latest Latest
Warning

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

 Go to latest Published: Sep 11, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2023-06-01/packetcorecontrolplaneversion Documentation

The packetcorecontrolplaneversion SDK allows for interaction with the Azure Resource Manager Service mobilenetwork (API Version 2023-06-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-06-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.GetBySubscription

ctx := context.TODO()
id := packetcorecontrolplaneversion.NewProviderPacketCoreControlPlaneVersionID("12345678-1234-9876-4563-123456789012", "packetCoreControlPlaneVersionValue")

read, err := client.GetBySubscription(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
}

Example Usage: PacketCoreControlPlaneVersionClient.ListBySubscription

ctx := context.TODO()
id := packetcorecontrolplaneversion.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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

func ValidateProviderPacketCoreControlPlaneVersionID 

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

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

Types

type GetBySubscriptionOperationResponse 

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

type GetOperationResponse 

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

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	Items []PacketCoreControlPlaneVersion
}

type ListBySubscriptionOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	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 added in v0.20230713.1092427 

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) GetBySubscription 

func (c PacketCoreControlPlaneVersionClient) GetBySubscription(ctx context.Context, id ProviderPacketCoreControlPlaneVersionId) (result GetBySubscriptionOperationResponse, err error)

GetBySubscription ...

func (PacketCoreControlPlaneVersionClient) List 

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

List ...

func (PacketCoreControlPlaneVersionClient) ListBySubscription 

func (c PacketCoreControlPlaneVersionClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (PacketCoreControlPlaneVersionClient) ListBySubscriptionComplete 

func (c PacketCoreControlPlaneVersionClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (PacketCoreControlPlaneVersionClient) ListBySubscriptionCompleteMatchingPredicate 

func (c PacketCoreControlPlaneVersionClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate PacketCoreControlPlaneVersionOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

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) 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 added in v0.20230713.1092427 

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

type ProviderPacketCoreControlPlaneVersionId 

type ProviderPacketCoreControlPlaneVersionId struct {
	SubscriptionId                    string
	PacketCoreControlPlaneVersionName string
}

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

func NewProviderPacketCoreControlPlaneVersionID 

func NewProviderPacketCoreControlPlaneVersionID(subscriptionId string, packetCoreControlPlaneVersionName string) ProviderPacketCoreControlPlaneVersionId

NewProviderPacketCoreControlPlaneVersionID returns a new ProviderPacketCoreControlPlaneVersionId struct

func ParseProviderPacketCoreControlPlaneVersionID 

func ParseProviderPacketCoreControlPlaneVersionID(input string) (*ProviderPacketCoreControlPlaneVersionId, error)

ParseProviderPacketCoreControlPlaneVersionID parses 'input' into a ProviderPacketCoreControlPlaneVersionId

func ParseProviderPacketCoreControlPlaneVersionIDInsensitively 

func ParseProviderPacketCoreControlPlaneVersionIDInsensitively(input string) (*ProviderPacketCoreControlPlaneVersionId, error)

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

func (ProviderPacketCoreControlPlaneVersionId) ID 

func (id ProviderPacketCoreControlPlaneVersionId) ID() string

ID returns the formatted Provider Packet Core Control Plane Version ID

func (ProviderPacketCoreControlPlaneVersionId) Segments 

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

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

func (ProviderPacketCoreControlPlaneVersionId) String 

func (id ProviderPacketCoreControlPlaneVersionId) String() string

String returns a human-readable description of this Provider Packet Core Control Plane Version 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 added in v0.20230713.1092427 

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

type RecommendedVersion 

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

func (*RecommendedVersion) UnmarshalJSON added in v0.20230713.1092427 

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 added in v0.20230713.1092427 

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

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.