README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-07-01/addons
Documentation
The addons
SDK allows for interaction with the Azure Resource Manager Service 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/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 ¶
- func PossibleValuesForAddonState() []string
- func PossibleValuesForAddonType() []string
- func PossibleValuesForEncryptionAlgorithm() []string
- func PossibleValuesForHostPlatformType() []string
- func PossibleValuesForPlatformType() []string
- func ValidateAddonID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateRoleID(input interface{}, key string) (warnings []string, errors []error)
- type Addon
- type AddonId
- type AddonOperationPredicate
- type AddonState
- type AddonType
- type AddonsClient
- func (c AddonsClient) CreateOrUpdate(ctx context.Context, id AddonId, input Addon) (result CreateOrUpdateOperationResponse, err error)
- func (c AddonsClient) CreateOrUpdateThenPoll(ctx context.Context, id AddonId, input Addon) error
- func (c AddonsClient) Delete(ctx context.Context, id AddonId) (result DeleteOperationResponse, err error)
- func (c AddonsClient) DeleteThenPoll(ctx context.Context, id AddonId) error
- func (c AddonsClient) Get(ctx context.Context, id AddonId) (result GetOperationResponse, err error)
- func (c AddonsClient) ListByRole(ctx context.Context, id RoleId) (result ListByRoleOperationResponse, err error)
- func (c AddonsClient) ListByRoleComplete(ctx context.Context, id RoleId) (ListByRoleCompleteResult, error)
- func (c AddonsClient) ListByRoleCompleteMatchingPredicate(ctx context.Context, id RoleId, predicate AddonOperationPredicate) (result ListByRoleCompleteResult, err error)
- type ArcAddon
- type ArcAddonProperties
- type AsymmetricEncryptedSecret
- type Authentication
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type EncryptionAlgorithm
- type GetOperationResponse
- type HostPlatformType
- type IoTAddon
- type IoTAddonProperties
- type IoTDeviceInfo
- type ListByRoleCompleteResult
- type ListByRoleOperationResponse
- type PlatformType
- type RoleId
- type SymmetricKey
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 ¶
ValidateAddonID checks that 'input' can be parsed as a Addon ID
func ValidateRoleID ¶
ValidateRoleID checks that 'input' can be parsed as a Role ID
Types ¶
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 ¶
ParseAddonID parses 'input' into a AddonId
func ParseAddonIDInsensitively ¶
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) Segments ¶
func (id AddonId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise 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" )
func (*AddonState) UnmarshalJSON ¶
func (s *AddonState) UnmarshalJSON(bytes []byte) error
type AddonsClient ¶
type AddonsClient struct {
Client *resourcemanager.Client
}
func NewAddonsClientWithBaseURI ¶
func NewAddonsClientWithBaseURI(api environments.Api) (*AddonsClient, error)
func (AddonsClient) CreateOrUpdate ¶
func (c AddonsClient) CreateOrUpdate(ctx context.Context, id AddonId, input Addon) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (AddonsClient) CreateOrUpdateThenPoll ¶
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) (result ListByRoleOperationResponse, err error)
ListByRole ...
func (AddonsClient) ListByRoleComplete ¶
func (c AddonsClient) ListByRoleComplete(ctx context.Context, id RoleId) (ListByRoleCompleteResult, error)
ListByRoleComplete retrieves all the results into a single object
func (AddonsClient) ListByRoleCompleteMatchingPredicate ¶
func (c AddonsClient) ListByRoleCompleteMatchingPredicate(ctx context.Context, id RoleId, predicate AddonOperationPredicate) (result ListByRoleCompleteResult, err error)
ListByRoleCompleteMatchingPredicate retrieves all the results and then applies 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 ¶
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 DeleteOperationResponse ¶
type EncryptionAlgorithm ¶
type EncryptionAlgorithm string
const ( EncryptionAlgorithmAESTwoFiveSix EncryptionAlgorithm = "AES256" EncryptionAlgorithmNone EncryptionAlgorithm = "None" EncryptionAlgorithmRSAESPKCSOneVOneFive EncryptionAlgorithm = "RSAES_PKCS1_v_1_5" )
func (*EncryptionAlgorithm) UnmarshalJSON ¶
func (s *EncryptionAlgorithm) UnmarshalJSON(bytes []byte) error
type GetOperationResponse ¶
type HostPlatformType ¶
type HostPlatformType string
const ( HostPlatformTypeKubernetesCluster HostPlatformType = "KubernetesCluster" HostPlatformTypeLinuxVM HostPlatformType = "LinuxVM" )
func (*HostPlatformType) UnmarshalJSON ¶
func (s *HostPlatformType) UnmarshalJSON(bytes []byte) error
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 ¶
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 PlatformType ¶
type PlatformType string
const ( PlatformTypeLinux PlatformType = "Linux" PlatformTypeWindows PlatformType = "Windows" )
func (*PlatformType) UnmarshalJSON ¶
func (s *PlatformType) UnmarshalJSON(bytes []byte) error
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 ¶
ParseRoleID parses 'input' into a RoleId
func ParseRoleIDInsensitively ¶
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) Segments ¶
func (id RoleId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Role ID
type SymmetricKey ¶
type SymmetricKey struct {
ConnectionString *AsymmetricEncryptedSecret `json:"connectionString,omitempty"`
}
Source Files ¶
- client.go
- constants.go
- id_addon.go
- id_role.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_listbyrole.go
- model_addon.go
- model_arcaddon.go
- model_arcaddonproperties.go
- model_asymmetricencryptedsecret.go
- model_authentication.go
- model_iotaddon.go
- model_iotaddonproperties.go
- model_iotdeviceinfo.go
- model_symmetrickey.go
- predicates.go
- version.go