packetcorecontrolplane

package
v0.20240321.1111417 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := packetcorecontrolplane.NewPacketCoreControlPlaneClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PacketCoreControlPlaneClient.CreateOrUpdate

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

payload := packetcorecontrolplane.PacketCoreControlPlane{
	// ...
}


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

Example Usage: PacketCoreControlPlaneClient.Delete

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

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

Example Usage: PacketCoreControlPlaneClient.Get

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

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

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

payload := packetcorecontrolplane.IdentityAndTagsObject{
	// ...
}


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

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 PossibleValuesForInstallationReason

func PossibleValuesForInstallationReason() []string

func PossibleValuesForInstallationState

func PossibleValuesForInstallationState() []string

func PossibleValuesForPlatformType

func PossibleValuesForPlatformType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReinstallRequired

func PossibleValuesForReinstallRequired() []string

func ValidatePacketCoreControlPlaneID

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

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

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 CreateOrUpdateOperationResponse

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

type CustomLocationResourceId

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

type DeleteOperationResponse

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

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 GetOperationResponse

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

type HTTPSServerCertificate

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

type IdentityAndTagsObject

type IdentityAndTagsObject struct {
	Identity *identity.UserAssignedMap `json:"identity,omitempty"`
	Tags     *map[string]string        `json:"tags,omitempty"`
}

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 (
	InstallationReasonNoAttachedDataNetworks InstallationReason = "NoAttachedDataNetworks"
	InstallationReasonNoPacketCoreDataPlane  InstallationReason = "NoPacketCoreDataPlane"
	InstallationReasonNoSlices               InstallationReason = "NoSlices"
)

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 {
	IPv4Address *string `json:"ipv4Address,omitempty"`
	IPv4Gateway *string `json:"ipv4Gateway,omitempty"`
	IPv4Subnet  *string `json:"ipv4Subnet,omitempty"`
	Name        *string `json:"name,omitempty"`
}

type LocalDiagnosticsAccessConfiguration

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

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 PacketCoreControlPlaneClient

type PacketCoreControlPlaneClient struct {
	Client *resourcemanager.Client
}

func NewPacketCoreControlPlaneClientWithBaseURI

func NewPacketCoreControlPlaneClientWithBaseURI(sdkApi sdkEnv.Api) (*PacketCoreControlPlaneClient, error)

func (PacketCoreControlPlaneClient) CreateOrUpdate

CreateOrUpdate ...

func (PacketCoreControlPlaneClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PacketCoreControlPlaneClient) Delete

Delete ...

func (PacketCoreControlPlaneClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (PacketCoreControlPlaneClient) Get

Get ...

func (PacketCoreControlPlaneClient) UpdateTags

UpdateTags ...

type PacketCoreControlPlaneId

type PacketCoreControlPlaneId struct {
	SubscriptionId             string
	ResourceGroupName          string
	PacketCoreControlPlaneName string
}

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

func NewPacketCoreControlPlaneID

func NewPacketCoreControlPlaneID(subscriptionId string, resourceGroupName string, packetCoreControlPlaneName string) PacketCoreControlPlaneId

NewPacketCoreControlPlaneID returns a new PacketCoreControlPlaneId struct

func ParsePacketCoreControlPlaneID

func ParsePacketCoreControlPlaneID(input string) (*PacketCoreControlPlaneId, error)

ParsePacketCoreControlPlaneID parses 'input' into a PacketCoreControlPlaneId

func ParsePacketCoreControlPlaneIDInsensitively

func ParsePacketCoreControlPlaneIDInsensitively(input string) (*PacketCoreControlPlaneId, error)

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

func (*PacketCoreControlPlaneId) FromParseResult

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

func (PacketCoreControlPlaneId) ID

ID returns the formatted Packet Core Control Plane ID

func (PacketCoreControlPlaneId) Segments

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

func (PacketCoreControlPlaneId) String

func (id PacketCoreControlPlaneId) String() string

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

type PacketCoreControlPlanePropertiesFormat

type PacketCoreControlPlanePropertiesFormat struct {
	ControlPlaneAccessInterface InterfaceProperties                 `json:"controlPlaneAccessInterface"`
	CoreNetworkTechnology       *CoreNetworkType                    `json:"coreNetworkTechnology,omitempty"`
	DiagnosticsUpload           *DiagnosticsUploadConfiguration     `json:"diagnosticsUpload,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"`
	Sites                       []SiteResourceId                    `json:"sites"`
	Sku                         BillingSku                          `json:"sku"`
	UeMtu                       *int64                              `json:"ueMtu,omitempty"`
	Version                     *string                             `json:"version,omitempty"`
}

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 SiteResourceId

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

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PacketCoreControlPlane
}

Jump to

Keyboard shortcuts

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