packetcorecontrolplaneversion

package
v0.20240209.1120443 Latest Latest
Warning

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

Go to latest
Published: Feb 9, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The packetcorecontrolplaneversion 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2023-09-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 := commonids.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 {
	LatestHttpResponse *http.Response
	Items              []PacketCoreControlPlaneVersion
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse 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

Get ...

func (PacketCoreControlPlaneVersionClient) GetBySubscription

GetBySubscription ...

func (PacketCoreControlPlaneVersionClient) List

List ...

func (PacketCoreControlPlaneVersionClient) ListBySubscription

ListBySubscription ...

func (PacketCoreControlPlaneVersionClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (PacketCoreControlPlaneVersionClient) ListBySubscriptionCompleteMatchingPredicate

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PacketCoreControlPlaneVersionClient) ListComplete

ListComplete retrieves all the results into a single object

func (PacketCoreControlPlaneVersionClient) ListCompleteMatchingPredicate

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

ID returns the formatted Packet Core Control Plane Version ID

func (PacketCoreControlPlaneVersionId) Segments

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

func (PacketCoreControlPlaneVersionId) 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

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

func (ProviderPacketCoreControlPlaneVersionId) ID

ID returns the formatted Provider Packet Core Control Plane Version ID

func (ProviderPacketCoreControlPlaneVersionId) Segments

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

func (ProviderPacketCoreControlPlaneVersionId) 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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL