packetcorecontrolplanes

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

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

The packetcorecontrolplanes SDK allows for interaction with Azure Resource Manager 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-04-01/packetcorecontrolplanes"

Client Initialization

client := packetcorecontrolplanes.NewPacketCoreControlPlanesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PacketCoreControlPlanesClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: PacketCoreControlPlanesClient.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 PossibleValuesForAuthenticationType 

func PossibleValuesForAuthenticationType() []string

func PossibleValuesForBillingSku 

func PossibleValuesForBillingSku() []string

func PossibleValuesForCertificateProvisioningState 

func PossibleValuesForCertificateProvisioningState() []string

func PossibleValuesForCoreNetworkType 

func PossibleValuesForCoreNetworkType() []string

func PossibleValuesForDesiredInstallationState 

func PossibleValuesForDesiredInstallationState() []string

func PossibleValuesForHomeNetworkPrivateKeysProvisioningState 

func PossibleValuesForHomeNetworkPrivateKeysProvisioningState() []string

func PossibleValuesForInstallationReason 

func PossibleValuesForInstallationReason() []string

func PossibleValuesForInstallationState 

func PossibleValuesForInstallationState() []string

func PossibleValuesForNasEncryptionType 

func PossibleValuesForNasEncryptionType() []string

func PossibleValuesForPlatformType 

func PossibleValuesForPlatformType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReinstallRequired 

func PossibleValuesForReinstallRequired() []string

Types

type AsyncOperationId 

type AsyncOperationId struct {
	Id string `json:"id"`
}

type AuthenticationType 

type AuthenticationType string
const (
	AuthenticationTypeAAD      AuthenticationType = "AAD"
	AuthenticationTypePassword AuthenticationType = "Password"
)

func (*AuthenticationType) UnmarshalJSON 

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

type AzureStackEdgeDeviceResourceId 

type AzureStackEdgeDeviceResourceId struct {
	Id string `json:"id"`
}

type AzureStackHCIClusterResourceId 

type AzureStackHCIClusterResourceId struct {
	Id string `json:"id"`
}

type BillingSku 

type BillingSku string
const (
	BillingSkuGFive    BillingSku = "G5"
	BillingSkuGOne     BillingSku = "G1"
	BillingSkuGOneZero BillingSku = "G10"
	BillingSkuGTwo     BillingSku = "G2"
	BillingSkuGZero    BillingSku = "G0"
)

func (*BillingSku) UnmarshalJSON 

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

type CertificateProvisioning 

type CertificateProvisioning struct {
	Reason *string                       `json:"reason,omitempty"`
	State  *CertificateProvisioningState `json:"state,omitempty"`
}

type CertificateProvisioningState 

type CertificateProvisioningState string
const (
	CertificateProvisioningStateFailed         CertificateProvisioningState = "Failed"
	CertificateProvisioningStateNotProvisioned CertificateProvisioningState = "NotProvisioned"
	CertificateProvisioningStateProvisioned    CertificateProvisioningState = "Provisioned"
)

func (*CertificateProvisioningState) UnmarshalJSON 

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

type ConnectedClusterResourceId 

type ConnectedClusterResourceId struct {
	Id string `json:"id"`
}

type CoreNetworkType 

type CoreNetworkType string
const (
	CoreNetworkTypeEPC               CoreNetworkType = "EPC"
	CoreNetworkTypeEPCPositiveFiveGC CoreNetworkType = "EPC + 5GC"
	CoreNetworkTypeFiveGC            CoreNetworkType = "5GC"
)

func (*CoreNetworkType) UnmarshalJSON 

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

type CustomLocationResourceId 

type CustomLocationResourceId struct {
	Id string `json:"id"`
}

type DesiredInstallationState 

type DesiredInstallationState string
const (
	DesiredInstallationStateInstalled   DesiredInstallationState = "Installed"
	DesiredInstallationStateUninstalled DesiredInstallationState = "Uninstalled"
)

func (*DesiredInstallationState) UnmarshalJSON 

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

type DiagnosticsUploadConfiguration 

type DiagnosticsUploadConfiguration struct {
	StorageAccountContainerURL string `json:"storageAccountContainerUrl"`
}

type EventHubConfiguration 

type EventHubConfiguration struct {
	Id                string `json:"id"`
	ReportingInterval *int64 `json:"reportingInterval,omitempty"`
}

type HTTPSServerCertificate 

type HTTPSServerCertificate struct {
	CertificateURL string                   `json:"certificateUrl"`
	Provisioning   *CertificateProvisioning `json:"provisioning,omitempty"`
}

type HomeNetworkPrivateKeysProvisioning 

type HomeNetworkPrivateKeysProvisioning struct {
	State HomeNetworkPrivateKeysProvisioningState `json:"state"`
}

type HomeNetworkPrivateKeysProvisioningState 

type HomeNetworkPrivateKeysProvisioningState string
const (
	HomeNetworkPrivateKeysProvisioningStateFailed         HomeNetworkPrivateKeysProvisioningState = "Failed"
	HomeNetworkPrivateKeysProvisioningStateNotProvisioned HomeNetworkPrivateKeysProvisioningState = "NotProvisioned"
	HomeNetworkPrivateKeysProvisioningStateProvisioned    HomeNetworkPrivateKeysProvisioningState = "Provisioned"
)

func (*HomeNetworkPrivateKeysProvisioningState) UnmarshalJSON 

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

type Installation 

type Installation struct {
	DesiredState      *DesiredInstallationState `json:"desiredState,omitempty"`
	Operation         *AsyncOperationId         `json:"operation,omitempty"`
	Reasons           *[]InstallationReason     `json:"reasons,omitempty"`
	ReinstallRequired *ReinstallRequired        `json:"reinstallRequired,omitempty"`
	State             *InstallationState        `json:"state,omitempty"`
}

type InstallationReason 

type InstallationReason string
const (
	InstallationReasonControlPlaneAccessInterfaceHasChanged               InstallationReason = "ControlPlaneAccessInterfaceHasChanged"
	InstallationReasonControlPlaneAccessVirtualIPvFourAddressesHasChanged InstallationReason = "ControlPlaneAccessVirtualIpv4AddressesHasChanged"
	InstallationReasonNoAttachedDataNetworks                              InstallationReason = "NoAttachedDataNetworks"
	InstallationReasonNoPacketCoreDataPlane                               InstallationReason = "NoPacketCoreDataPlane"
	InstallationReasonNoSlices                                            InstallationReason = "NoSlices"
	InstallationReasonPublicLandMobileNetworkIdentifierHasChanged         InstallationReason = "PublicLandMobileNetworkIdentifierHasChanged"
	InstallationReasonUserPlaneAccessInterfaceHasChanged                  InstallationReason = "UserPlaneAccessInterfaceHasChanged"
	InstallationReasonUserPlaneAccessVirtualIPvFourAddressesHasChanged    InstallationReason = "UserPlaneAccessVirtualIpv4AddressesHasChanged"
	InstallationReasonUserPlaneDataInterfaceHasChanged                    InstallationReason = "UserPlaneDataInterfaceHasChanged"
)

func (*InstallationReason) UnmarshalJSON 

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

type InstallationState 

type InstallationState string
const (
	InstallationStateFailed       InstallationState = "Failed"
	InstallationStateInstalled    InstallationState = "Installed"
	InstallationStateInstalling   InstallationState = "Installing"
	InstallationStateReinstalling InstallationState = "Reinstalling"
	InstallationStateRollingBack  InstallationState = "RollingBack"
	InstallationStateUninstalled  InstallationState = "Uninstalled"
	InstallationStateUninstalling InstallationState = "Uninstalling"
	InstallationStateUpdating     InstallationState = "Updating"
	InstallationStateUpgrading    InstallationState = "Upgrading"
)

func (*InstallationState) UnmarshalJSON 

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

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 ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PacketCoreControlPlane
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PacketCoreControlPlane
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PacketCoreControlPlane
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationResponse 

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

type LocalDiagnosticsAccessConfiguration 

type LocalDiagnosticsAccessConfiguration struct {
	AuthenticationType     AuthenticationType      `json:"authenticationType"`
	HTTPSServerCertificate *HTTPSServerCertificate `json:"httpsServerCertificate,omitempty"`
}

type NASRerouteConfiguration 

type NASRerouteConfiguration struct {
	MacroMmeGroupId int64 `json:"macroMmeGroupId"`
}

type NasEncryptionType 

type NasEncryptionType string
const (
	NasEncryptionTypeNEAOneEEAOne   NasEncryptionType = "NEA1/EEA1"
	NasEncryptionTypeNEATwoEEATwo   NasEncryptionType = "NEA2/EEA2"
	NasEncryptionTypeNEAZeroEEAZero NasEncryptionType = "NEA0/EEA0"
)

func (*NasEncryptionType) UnmarshalJSON 

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

type PacketCoreControlPlane 

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

type PacketCoreControlPlaneOperationPredicate 

type PacketCoreControlPlaneOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (PacketCoreControlPlaneOperationPredicate) Matches 

func (p PacketCoreControlPlaneOperationPredicate) Matches(input PacketCoreControlPlane) bool

type PacketCoreControlPlanePropertiesFormat 

type PacketCoreControlPlanePropertiesFormat struct {
	ControlPlaneAccessInterface            InterfaceProperties                 `json:"controlPlaneAccessInterface"`
	ControlPlaneAccessVirtualIPv4Addresses *[]string                           `json:"controlPlaneAccessVirtualIpv4Addresses,omitempty"`
	CoreNetworkTechnology                  *CoreNetworkType                    `json:"coreNetworkTechnology,omitempty"`
	DiagnosticsUpload                      *DiagnosticsUploadConfiguration     `json:"diagnosticsUpload,omitempty"`
	EventHub                               *EventHubConfiguration              `json:"eventHub,omitempty"`
	HomeNetworkPrivateKeysProvisioning     *HomeNetworkPrivateKeysProvisioning `json:"homeNetworkPrivateKeysProvisioning,omitempty"`
	Installation                           *Installation                       `json:"installation,omitempty"`
	InstalledVersion                       *string                             `json:"installedVersion,omitempty"`
	InteropSettings                        *interface{}                        `json:"interopSettings,omitempty"`
	LocalDiagnosticsAccess                 LocalDiagnosticsAccessConfiguration `json:"localDiagnosticsAccess"`
	Platform                               PlatformConfiguration               `json:"platform"`
	ProvisioningState                      *ProvisioningState                  `json:"provisioningState,omitempty"`
	RollbackVersion                        *string                             `json:"rollbackVersion,omitempty"`
	Signaling                              *SignalingConfiguration             `json:"signaling,omitempty"`
	Sites                                  []SiteResourceId                    `json:"sites"`
	Sku                                    BillingSku                          `json:"sku"`
	UeMtu                                  *int64                              `json:"ueMtu,omitempty"`
	UserConsent                            *UserConsentConfiguration           `json:"userConsent,omitempty"`
	Version                                *string                             `json:"version,omitempty"`
}

type PacketCoreControlPlanesClient 

type PacketCoreControlPlanesClient struct {
	Client *resourcemanager.Client
}

func NewPacketCoreControlPlanesClientWithBaseURI 

func NewPacketCoreControlPlanesClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreControlPlanesClient, error)

func (PacketCoreControlPlanesClient) ListByResourceGroup 

func (c PacketCoreControlPlanesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (PacketCoreControlPlanesClient) ListByResourceGroupComplete 

func (c PacketCoreControlPlanesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (PacketCoreControlPlanesClient) ListByResourceGroupCompleteMatchingPredicate 

func (c PacketCoreControlPlanesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate PacketCoreControlPlaneOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PacketCoreControlPlanesClient) ListBySubscription 

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

ListBySubscription ...

func (PacketCoreControlPlanesClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (PacketCoreControlPlanesClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PlatformConfiguration 

type PlatformConfiguration struct {
	AzureStackEdgeDevice  *AzureStackEdgeDeviceResourceId   `json:"azureStackEdgeDevice,omitempty"`
	AzureStackEdgeDevices *[]AzureStackEdgeDeviceResourceId `json:"azureStackEdgeDevices,omitempty"`
	AzureStackHciCluster  *AzureStackHCIClusterResourceId   `json:"azureStackHciCluster,omitempty"`
	ConnectedCluster      *ConnectedClusterResourceId       `json:"connectedCluster,omitempty"`
	CustomLocation        *CustomLocationResourceId         `json:"customLocation,omitempty"`
	Type                  PlatformType                      `json:"type"`
}

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 ReinstallRequired 

type ReinstallRequired string
const (
	ReinstallRequiredNotRequired ReinstallRequired = "NotRequired"
	ReinstallRequiredRequired    ReinstallRequired = "Required"
)

func (*ReinstallRequired) UnmarshalJSON 

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

type SignalingConfiguration 

type SignalingConfiguration struct {
	NasEncryption *[]NasEncryptionType     `json:"nasEncryption,omitempty"`
	NasReroute    *NASRerouteConfiguration `json:"nasReroute,omitempty"`
}

type SiteResourceId 

type SiteResourceId struct {
	Id string `json:"id"`
}

type UserConsentConfiguration 

type UserConsentConfiguration struct {
	AllowSupportTelemetryAccess *bool `json:"allowSupportTelemetryAccess,omitempty"`
}

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.