diagnosticspackages

package
v0.20240621.1124930 Latest Latest
Warning

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

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

README

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

The diagnosticspackages 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-sdk/resource-manager/mobilenetwork/2023-09-01/diagnosticspackages"

Client Initialization

client := diagnosticspackages.NewDiagnosticsPackagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DiagnosticsPackagesClient.CreateOrUpdate

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

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

Example Usage: DiagnosticsPackagesClient.Delete

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

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

Example Usage: DiagnosticsPackagesClient.Get

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

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: DiagnosticsPackagesClient.ListByPacketCoreControlPlane

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

// alternatively `client.ListByPacketCoreControlPlane(ctx, id)` can be used to do batched pagination
items, err := client.ListByPacketCoreControlPlaneComplete(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 PossibleValuesForDiagnosticsPackageStatus

func PossibleValuesForDiagnosticsPackageStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateDiagnosticsPackageID

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

ValidateDiagnosticsPackageID checks that 'input' can be parsed as a Diagnostics Package ID

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 CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DiagnosticsPackage

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

type DiagnosticsPackageId

type DiagnosticsPackageId struct {
	SubscriptionId             string
	ResourceGroupName          string
	PacketCoreControlPlaneName string
	DiagnosticsPackageName     string
}

DiagnosticsPackageId is a struct representing the Resource ID for a Diagnostics Package

func NewDiagnosticsPackageID

func NewDiagnosticsPackageID(subscriptionId string, resourceGroupName string, packetCoreControlPlaneName string, diagnosticsPackageName string) DiagnosticsPackageId

NewDiagnosticsPackageID returns a new DiagnosticsPackageId struct

func ParseDiagnosticsPackageID

func ParseDiagnosticsPackageID(input string) (*DiagnosticsPackageId, error)

ParseDiagnosticsPackageID parses 'input' into a DiagnosticsPackageId

func ParseDiagnosticsPackageIDInsensitively

func ParseDiagnosticsPackageIDInsensitively(input string) (*DiagnosticsPackageId, error)

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

func (*DiagnosticsPackageId) FromParseResult

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

func (DiagnosticsPackageId) ID

func (id DiagnosticsPackageId) ID() string

ID returns the formatted Diagnostics Package ID

func (DiagnosticsPackageId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Diagnostics Package ID

func (DiagnosticsPackageId) String

func (id DiagnosticsPackageId) String() string

String returns a human-readable description of this Diagnostics Package ID

type DiagnosticsPackageOperationPredicate

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

func (DiagnosticsPackageOperationPredicate) Matches

type DiagnosticsPackagePropertiesFormat

type DiagnosticsPackagePropertiesFormat struct {
	ProvisioningState *ProvisioningState        `json:"provisioningState,omitempty"`
	Reason            *string                   `json:"reason,omitempty"`
	Status            *DiagnosticsPackageStatus `json:"status,omitempty"`
}

type DiagnosticsPackageStatus

type DiagnosticsPackageStatus string
const (
	DiagnosticsPackageStatusCollected  DiagnosticsPackageStatus = "Collected"
	DiagnosticsPackageStatusCollecting DiagnosticsPackageStatus = "Collecting"
	DiagnosticsPackageStatusError      DiagnosticsPackageStatus = "Error"
	DiagnosticsPackageStatusNotStarted DiagnosticsPackageStatus = "NotStarted"
)

func (*DiagnosticsPackageStatus) UnmarshalJSON

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

type DiagnosticsPackagesClient

type DiagnosticsPackagesClient struct {
	Client *resourcemanager.Client
}

func NewDiagnosticsPackagesClientWithBaseURI

func NewDiagnosticsPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*DiagnosticsPackagesClient, error)

func (DiagnosticsPackagesClient) CreateOrUpdate

CreateOrUpdate ...

func (DiagnosticsPackagesClient) CreateOrUpdateThenPoll

func (c DiagnosticsPackagesClient) CreateOrUpdateThenPoll(ctx context.Context, id DiagnosticsPackageId) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DiagnosticsPackagesClient) Delete

Delete ...

func (DiagnosticsPackagesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (DiagnosticsPackagesClient) Get

Get ...

func (DiagnosticsPackagesClient) ListByPacketCoreControlPlane

ListByPacketCoreControlPlane ...

func (DiagnosticsPackagesClient) ListByPacketCoreControlPlaneComplete

ListByPacketCoreControlPlaneComplete retrieves all the results into a single object

func (DiagnosticsPackagesClient) ListByPacketCoreControlPlaneCompleteMatchingPredicate

func (c DiagnosticsPackagesClient) ListByPacketCoreControlPlaneCompleteMatchingPredicate(ctx context.Context, id PacketCoreControlPlaneId, predicate DiagnosticsPackageOperationPredicate) (result ListByPacketCoreControlPlaneCompleteResult, err error)

ListByPacketCoreControlPlaneCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListByPacketCoreControlPlaneCompleteResult

type ListByPacketCoreControlPlaneCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiagnosticsPackage
}

type ListByPacketCoreControlPlaneOperationResponse

type ListByPacketCoreControlPlaneOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiagnosticsPackage
}

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

Jump to

Keyboard shortcuts

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