package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# 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
}
# Functions
NewAddonID returns a new AddonId struct.
No description provided by the author
NewRoleID returns a new RoleId struct.
ParseAddonID parses 'input' into a AddonId.
ParseAddonIDInsensitively parses 'input' case-insensitively into a AddonId note: this method should only be used for API response data and not user input.
ParseRoleID parses 'input' into a RoleId.
ParseRoleIDInsensitively parses 'input' case-insensitively into a RoleId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateAddonID checks that 'input' can be parsed as a Addon ID.
ValidateRoleID checks that 'input' can be parsed as a Role ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AddonId is a struct representing the Resource ID for a Addon.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RawAddonImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RoleId is a struct representing the Resource ID for a Role.
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author