supportpackages

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-07-01/supportpackages Documentation

The supportpackages SDK allows for interaction with Azure Resource Manager databoxedge (API Version 2023-07-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/databoxedge/2023-07-01/supportpackages"

Client Initialization

client := supportpackages.NewSupportPackagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SupportPackagesClient.TriggerSupportPackage

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

payload := supportpackages.TriggerSupportPackageRequest{
	// ...
}


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

Documentation

Index

• func ValidateDataBoxEdgeDeviceID(input interface{}, key string) (warnings []string, errors []error)
• type DataBoxEdgeDeviceId
  • func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId
  • func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)
  • func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)
  • func (id *DataBoxEdgeDeviceId) FromParseResult(input resourceids.ParseResult) error
  • func (id DataBoxEdgeDeviceId) ID() string
  • func (id DataBoxEdgeDeviceId) Segments() []resourceids.Segment
  • func (id DataBoxEdgeDeviceId) String() string
• type SupportPackageRequestProperties
  • func (o *SupportPackageRequestProperties) GetMaximumTimeStampAsTime() (*time.Time, error)
  • func (o *SupportPackageRequestProperties) GetMinimumTimeStampAsTime() (*time.Time, error)
  • func (o *SupportPackageRequestProperties) SetMaximumTimeStampAsTime(input time.Time)
  • func (o *SupportPackageRequestProperties) SetMinimumTimeStampAsTime(input time.Time)
• type SupportPackagesClient
  • func NewSupportPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SupportPackagesClient, error)
  • func (c SupportPackagesClient) TriggerSupportPackage(ctx context.Context, id DataBoxEdgeDeviceId, ...) (result TriggerSupportPackageOperationResponse, err error)
  • func (c SupportPackagesClient) TriggerSupportPackageThenPoll(ctx context.Context, id DataBoxEdgeDeviceId, ...) error
• type TriggerSupportPackageOperationResponse
• type TriggerSupportPackageRequest

Functions

func ValidateDataBoxEdgeDeviceID

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

ValidateDataBoxEdgeDeviceID checks that 'input' can be parsed as a Data Box Edge Device ID

Types

type DataBoxEdgeDeviceId

type DataBoxEdgeDeviceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
}

DataBoxEdgeDeviceId is a struct representing the Resource ID for a Data Box Edge Device

func NewDataBoxEdgeDeviceID

func NewDataBoxEdgeDeviceID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string) DataBoxEdgeDeviceId

NewDataBoxEdgeDeviceID returns a new DataBoxEdgeDeviceId struct

func ParseDataBoxEdgeDeviceID

func ParseDataBoxEdgeDeviceID(input string) (*DataBoxEdgeDeviceId, error)

ParseDataBoxEdgeDeviceID parses 'input' into a DataBoxEdgeDeviceId

func ParseDataBoxEdgeDeviceIDInsensitively

func ParseDataBoxEdgeDeviceIDInsensitively(input string) (*DataBoxEdgeDeviceId, error)

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

func (*DataBoxEdgeDeviceId) FromParseResult

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

func (DataBoxEdgeDeviceId) ID

func (id DataBoxEdgeDeviceId) ID() string

ID returns the formatted Data Box Edge Device ID

func (DataBoxEdgeDeviceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Data Box Edge Device ID

func (DataBoxEdgeDeviceId) String

func (id DataBoxEdgeDeviceId) String() string

String returns a human-readable description of this Data Box Edge Device ID

type SupportPackageRequestProperties

type SupportPackageRequestProperties struct {
	Include          *string `json:"include,omitempty"`
	MaximumTimeStamp *string `json:"maximumTimeStamp,omitempty"`
	MinimumTimeStamp *string `json:"minimumTimeStamp,omitempty"`
}

func (*SupportPackageRequestProperties) GetMaximumTimeStampAsTime

func (o *SupportPackageRequestProperties) GetMaximumTimeStampAsTime() (*time.Time, error)

func (*SupportPackageRequestProperties) GetMinimumTimeStampAsTime

func (o *SupportPackageRequestProperties) GetMinimumTimeStampAsTime() (*time.Time, error)

func (*SupportPackageRequestProperties) SetMaximumTimeStampAsTime

func (o *SupportPackageRequestProperties) SetMaximumTimeStampAsTime(input time.Time)

func (*SupportPackageRequestProperties) SetMinimumTimeStampAsTime

func (o *SupportPackageRequestProperties) SetMinimumTimeStampAsTime(input time.Time)

type SupportPackagesClient

type SupportPackagesClient struct {
	Client *resourcemanager.Client
}

func NewSupportPackagesClientWithBaseURI

func NewSupportPackagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SupportPackagesClient, error)

func (SupportPackagesClient) TriggerSupportPackage

func (c SupportPackagesClient) TriggerSupportPackage(ctx context.Context, id DataBoxEdgeDeviceId, input TriggerSupportPackageRequest) (result TriggerSupportPackageOperationResponse, err error)

TriggerSupportPackage ...

func (SupportPackagesClient) TriggerSupportPackageThenPoll

func (c SupportPackagesClient) TriggerSupportPackageThenPoll(ctx context.Context, id DataBoxEdgeDeviceId, input TriggerSupportPackageRequest) error

TriggerSupportPackageThenPoll performs TriggerSupportPackage then polls until it's completed

type TriggerSupportPackageOperationResponse

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

type TriggerSupportPackageRequest

type TriggerSupportPackageRequest struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties SupportPackageRequestProperties `json:"properties"`
	Type       *string                         `json:"type,omitempty"`
}