Categorygithub.com/hashicorp/go-azure-sdk/resource-managercompute2022-03-01virtualmachineruncommands
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/compute/2022-03-01/virtualmachineruncommands
Documentation
The virtualmachineruncommands
SDK allows for interaction with the Azure Resource Manager Service compute
(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/compute/2022-03-01/virtualmachineruncommands"
Client Initialization
client := virtualmachineruncommands.NewVirtualMachineRunCommandsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: VirtualMachineRunCommandsClient.CreateOrUpdate
ctx := context.TODO()
id := virtualmachineruncommands.NewVirtualMachineRunCommandID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineValue", "runCommandValue")
payload := virtualmachineruncommands.VirtualMachineRunCommand{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: VirtualMachineRunCommandsClient.Delete
ctx := context.TODO()
id := virtualmachineruncommands.NewVirtualMachineRunCommandID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineValue", "runCommandValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: VirtualMachineRunCommandsClient.Get
ctx := context.TODO()
id := virtualmachineruncommands.NewRunCommandID("12345678-1234-9876-4563-123456789012", "locationValue", "commandIdValue")
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: VirtualMachineRunCommandsClient.GetByVirtualMachine
ctx := context.TODO()
id := virtualmachineruncommands.NewVirtualMachineRunCommandID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineValue", "runCommandValue")
read, err := client.GetByVirtualMachine(ctx, id, virtualmachineruncommands.DefaultGetByVirtualMachineOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: VirtualMachineRunCommandsClient.List
ctx := context.TODO()
id := virtualmachineruncommands.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: VirtualMachineRunCommandsClient.ListByVirtualMachine
ctx := context.TODO()
id := virtualmachineruncommands.NewVirtualMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineValue")
// alternatively `client.ListByVirtualMachine(ctx, id, virtualmachineruncommands.DefaultListByVirtualMachineOperationOptions())` can be used to do batched pagination
items, err := client.ListByVirtualMachineComplete(ctx, id, virtualmachineruncommands.DefaultListByVirtualMachineOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: VirtualMachineRunCommandsClient.Update
ctx := context.TODO()
id := virtualmachineruncommands.NewVirtualMachineRunCommandID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualMachineValue", "runCommandValue")
payload := virtualmachineruncommands.VirtualMachineRunCommandUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
# Functions
No description provided by the author
No description provided by the author
NewLocationID returns a new LocationId struct.
NewRunCommandID returns a new RunCommandId struct.
NewVirtualMachineID returns a new VirtualMachineId struct.
NewVirtualMachineRunCommandID returns a new VirtualMachineRunCommandId struct.
No description provided by the author
ParseLocationID parses 'input' into a LocationId.
ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input.
ParseRunCommandID parses 'input' into a RunCommandId.
ParseRunCommandIDInsensitively parses 'input' case-insensitively into a RunCommandId note: this method should only be used for API response data and not user input.
ParseVirtualMachineID parses 'input' into a VirtualMachineId.
ParseVirtualMachineIDInsensitively parses 'input' case-insensitively into a VirtualMachineId note: this method should only be used for API response data and not user input.
ParseVirtualMachineRunCommandID parses 'input' into a VirtualMachineRunCommandId.
ParseVirtualMachineRunCommandIDInsensitively parses 'input' case-insensitively into a VirtualMachineRunCommandId 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
ValidateLocationID checks that 'input' can be parsed as a Location ID.
ValidateRunCommandID checks that 'input' can be parsed as a Run Command ID.
ValidateVirtualMachineID checks that 'input' can be parsed as a Virtual Machine ID.
ValidateVirtualMachineRunCommandID checks that 'input' can be parsed as a Virtual Machine Run Command 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
# 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
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
LocationId is a struct representing the Resource ID for a Location.
No description provided by the author
No description provided by the author
No description provided by the author
RunCommandId is a struct representing the Resource ID for a Run Command.
No description provided by the author
No description provided by the author
No description provided by the author
VirtualMachineId is a struct representing the Resource ID for a Virtual Machine.
No description provided by the author
VirtualMachineRunCommandId is a struct representing the Resource ID for a Virtual Machine Run Command.
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
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author