addons

package
v0.20230208.1165725 Latest Latest
Warning

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

Go to latest
Published: Feb 8, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2022-03-01/addons Documentation

The addons SDK allows for interaction with the Azure Resource Manager Service databoxedge (API Version 2022-03-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/2022-03-01/addons"

Client Initialization

client := addons.NewAddonsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AddonsClient.CreateOrUpdate

ctx := context.TODO()
id := addons.NewAddonID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "roleValue", "addonValue")

payload := addons.Addon{
	// ...
}


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

Example Usage: AddonsClient.Delete

ctx := context.TODO()
id := addons.NewAddonID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "roleValue", "addonValue")

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

Example Usage: AddonsClient.Get

ctx := context.TODO()
id := addons.NewAddonID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "roleValue", "addonValue")

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: AddonsClient.ListByRole

ctx := context.TODO()
id := addons.NewRoleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "roleValue")

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

func PossibleValuesForAddonState() []string

func PossibleValuesForAddonType

func PossibleValuesForAddonType() []string

func PossibleValuesForEncryptionAlgorithm

func PossibleValuesForEncryptionAlgorithm() []string

func PossibleValuesForHostPlatformType

func PossibleValuesForHostPlatformType() []string

func PossibleValuesForPlatformType

func PossibleValuesForPlatformType() []string

func ValidateAddonID

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

ValidateAddonID checks that 'input' can be parsed as a Addon ID

func ValidateRoleID

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

ValidateRoleID checks that 'input' can be parsed as a Role ID

Types

type Addon

type Addon interface {
}

type AddonId

type AddonId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
	RoleName              string
	AddonName             string
}

AddonId is a struct representing the Resource ID for a Addon

func NewAddonID

func NewAddonID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string, roleName string, addonName string) AddonId

NewAddonID returns a new AddonId struct

func ParseAddonID

func ParseAddonID(input string) (*AddonId, error)

ParseAddonID parses 'input' into a AddonId

func ParseAddonIDInsensitively

func ParseAddonIDInsensitively(input string) (*AddonId, error)

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

func (AddonId) ID

func (id AddonId) ID() string

ID returns the formatted Addon ID

func (AddonId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Addon ID

func (AddonId) String

func (id AddonId) String() string

String returns a human-readable description of this Addon ID

type AddonOperationPredicate

type AddonOperationPredicate struct {
}

func (AddonOperationPredicate) Matches

func (p AddonOperationPredicate) Matches(input Addon) bool

type AddonState

type AddonState string
const (
	AddonStateCreated       AddonState = "Created"
	AddonStateCreating      AddonState = "Creating"
	AddonStateDeleting      AddonState = "Deleting"
	AddonStateFailed        AddonState = "Failed"
	AddonStateInvalid       AddonState = "Invalid"
	AddonStateReconfiguring AddonState = "Reconfiguring"
	AddonStateUpdating      AddonState = "Updating"
)

type AddonType

type AddonType string
const (
	AddonTypeArcForKubernetes AddonType = "ArcForKubernetes"
	AddonTypeIotEdge          AddonType = "IotEdge"
)

type AddonsClient

type AddonsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewAddonsClientWithBaseURI

func NewAddonsClientWithBaseURI(endpoint string) AddonsClient

func (AddonsClient) CreateOrUpdate

func (c AddonsClient) CreateOrUpdate(ctx context.Context, id AddonId, input Addon) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AddonsClient) CreateOrUpdateThenPoll

func (c AddonsClient) CreateOrUpdateThenPoll(ctx context.Context, id AddonId, input Addon) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AddonsClient) Delete

func (c AddonsClient) Delete(ctx context.Context, id AddonId) (result DeleteOperationResponse, err error)

Delete ...

func (AddonsClient) DeleteThenPoll

func (c AddonsClient) DeleteThenPoll(ctx context.Context, id AddonId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AddonsClient) Get

func (c AddonsClient) Get(ctx context.Context, id AddonId) (result GetOperationResponse, err error)

Get ...

func (AddonsClient) ListByRole

func (c AddonsClient) ListByRole(ctx context.Context, id RoleId) (resp ListByRoleOperationResponse, err error)

ListByRole ...

func (AddonsClient) ListByRoleComplete

func (c AddonsClient) ListByRoleComplete(ctx context.Context, id RoleId) (ListByRoleCompleteResult, error)

ListByRoleComplete retrieves all of the results into a single object

func (AddonsClient) ListByRoleCompleteMatchingPredicate

func (c AddonsClient) ListByRoleCompleteMatchingPredicate(ctx context.Context, id RoleId, predicate AddonOperationPredicate) (resp ListByRoleCompleteResult, err error)

ListByRoleCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ArcAddon

type ArcAddon struct {
	Properties ArcAddonProperties `json:"properties"`

	// Fields inherited from Addon
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ArcAddon) MarshalJSON

func (s ArcAddon) MarshalJSON() ([]byte, error)

type ArcAddonProperties

type ArcAddonProperties struct {
	HostPlatform      *PlatformType     `json:"hostPlatform,omitempty"`
	HostPlatformType  *HostPlatformType `json:"hostPlatformType,omitempty"`
	ProvisioningState *AddonState       `json:"provisioningState,omitempty"`
	ResourceGroupName string            `json:"resourceGroupName"`
	ResourceLocation  string            `json:"resourceLocation"`
	ResourceName      string            `json:"resourceName"`
	SubscriptionId    string            `json:"subscriptionId"`
	Version           *string           `json:"version,omitempty"`
}

type AsymmetricEncryptedSecret

type AsymmetricEncryptedSecret struct {
	EncryptionAlgorithm      EncryptionAlgorithm `json:"encryptionAlgorithm"`
	EncryptionCertThumbprint *string             `json:"encryptionCertThumbprint,omitempty"`
	Value                    string              `json:"value"`
}

type Authentication

type Authentication struct {
	SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type EncryptionAlgorithm

type EncryptionAlgorithm string
const (
	EncryptionAlgorithmAESTwoFiveSix        EncryptionAlgorithm = "AES256"
	EncryptionAlgorithmNone                 EncryptionAlgorithm = "None"
	EncryptionAlgorithmRSAESPKCSOneVOneFive EncryptionAlgorithm = "RSAES_PKCS1_v_1_5"
)

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Addon
}

type HostPlatformType

type HostPlatformType string
const (
	HostPlatformTypeKubernetesCluster HostPlatformType = "KubernetesCluster"
	HostPlatformTypeLinuxVM           HostPlatformType = "LinuxVM"
)

type IoTAddon

type IoTAddon struct {
	Properties IoTAddonProperties `json:"properties"`

	// Fields inherited from Addon
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (IoTAddon) MarshalJSON

func (s IoTAddon) MarshalJSON() ([]byte, error)

type IoTAddonProperties

type IoTAddonProperties struct {
	HostPlatform         *PlatformType     `json:"hostPlatform,omitempty"`
	HostPlatformType     *HostPlatformType `json:"hostPlatformType,omitempty"`
	IoTDeviceDetails     IoTDeviceInfo     `json:"ioTDeviceDetails"`
	IoTEdgeDeviceDetails IoTDeviceInfo     `json:"ioTEdgeDeviceDetails"`
	ProvisioningState    *AddonState       `json:"provisioningState,omitempty"`
	Version              *string           `json:"version,omitempty"`
}

type IoTDeviceInfo

type IoTDeviceInfo struct {
	Authentication *Authentication `json:"authentication,omitempty"`
	DeviceId       string          `json:"deviceId"`
	IoTHostHub     string          `json:"ioTHostHub"`
	IoTHostHubId   *string         `json:"ioTHostHubId,omitempty"`
}

type ListByRoleCompleteResult

type ListByRoleCompleteResult struct {
	Items []Addon
}

type ListByRoleOperationResponse

type ListByRoleOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Addon
	// contains filtered or unexported fields
}

func (ListByRoleOperationResponse) HasMore

func (r ListByRoleOperationResponse) HasMore() bool

func (ListByRoleOperationResponse) LoadMore

type PlatformType

type PlatformType string
const (
	PlatformTypeLinux   PlatformType = "Linux"
	PlatformTypeWindows PlatformType = "Windows"
)

type RoleId

type RoleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
	RoleName              string
}

RoleId is a struct representing the Resource ID for a Role

func NewRoleID

func NewRoleID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string, roleName string) RoleId

NewRoleID returns a new RoleId struct

func ParseRoleID

func ParseRoleID(input string) (*RoleId, error)

ParseRoleID parses 'input' into a RoleId

func ParseRoleIDInsensitively

func ParseRoleIDInsensitively(input string) (*RoleId, error)

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

func (RoleId) ID

func (id RoleId) ID() string

ID returns the formatted Role ID

func (RoleId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Role ID

func (RoleId) String

func (id RoleId) String() string

String returns a human-readable description of this Role ID

type SymmetricKey

type SymmetricKey struct {
	ConnectionString *AsymmetricEncryptedSecret `json:"connectionString,omitempty"`
}

Jump to

Keyboard shortcuts

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