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/devtestlab/2018-09-15/disks
Documentation
The disks
SDK allows for interaction with the Azure Resource Manager Service devtestlab
(API Version 2018-09-15
).
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/devtestlab/2018-09-15/disks"
Client Initialization
client := disks.NewDisksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: DisksClient.Attach
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
payload := disks.AttachDiskProperties{
// ...
}
if err := client.AttachThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: DisksClient.CreateOrUpdate
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
payload := disks.Disk{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: DisksClient.Delete
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: DisksClient.Detach
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
payload := disks.DetachDiskProperties{
// ...
}
if err := client.DetachThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: DisksClient.Get
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
read, err := client.Get(ctx, id, disks.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: DisksClient.List
ctx := context.TODO()
id := disks.NewUserID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue")
// alternatively `client.List(ctx, id, disks.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, disks.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: DisksClient.Update
ctx := context.TODO()
id := disks.NewDiskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "userValue", "diskValue")
payload := disks.UpdateResource{
// ...
}
read, err := client.Update(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
# Functions
No description provided by the author
No description provided by the author
NewDiskID returns a new DiskId struct.
No description provided by the author
NewUserID returns a new UserId struct.
ParseDiskID parses 'input' into a DiskId.
ParseDiskIDInsensitively parses 'input' case-insensitively into a DiskId note: this method should only be used for API response data and not user input.
ParseUserID parses 'input' into a UserId.
ParseUserIDInsensitively parses 'input' case-insensitively into a UserId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateDiskID checks that 'input' can be parsed as a Disk ID.
ValidateUserID checks that 'input' can be parsed as a User ID.
# Constants
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
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
DiskId is a struct representing the Resource ID for a Disk.
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
UserId is a struct representing the Resource ID for a User.
# Type aliases
No description provided by the author