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/2022-03-01/containers
Documentation
The containers
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/containers"
Client Initialization
client := containers.NewContainersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ContainersClient.CreateOrUpdate
ctx := context.TODO()
id := containers.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountValue", "containerValue")
payload := containers.Container{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ContainersClient.Delete
ctx := context.TODO()
id := containers.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountValue", "containerValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ContainersClient.Get
ctx := context.TODO()
id := containers.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountValue", "containerValue")
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: ContainersClient.ListByStorageAccount
ctx := context.TODO()
id := containers.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountValue")
// alternatively `client.ListByStorageAccount(ctx, id)` can be used to do batched pagination
items, err := client.ListByStorageAccountComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ContainersClient.Refresh
ctx := context.TODO()
id := containers.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceValue", "storageAccountValue", "containerValue")
if err := client.RefreshThenPoll(ctx, id); err != nil {
// handle the error
}
# Functions
NewContainerID returns a new ContainerId struct.
No description provided by the author
NewStorageAccountID returns a new StorageAccountId struct.
ParseContainerID parses 'input' into a ContainerId.
ParseContainerIDInsensitively parses 'input' case-insensitively into a ContainerId note: this method should only be used for API response data and not user input.
ParseStorageAccountID parses 'input' into a StorageAccountId.
ParseStorageAccountIDInsensitively parses 'input' case-insensitively into a StorageAccountId 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
ValidateContainerID checks that 'input' can be parsed as a Container ID.
ValidateStorageAccountID checks that 'input' can be parsed as a Storage Account 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
# Structs
No description provided by the author
ContainerId is a struct representing the Resource ID for a Container.
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
StorageAccountId is a struct representing the Resource ID for a Storage Account.
# Type aliases
No description provided by the author
No description provided by the author