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/automation/2023-11-01/connection
Documentation
The connection
SDK allows for interaction with the Azure Resource Manager Service automation
(API Version 2023-11-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/automation/2023-11-01/connection"
Client Initialization
client := connection.NewConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ConnectionClient.CreateOrUpdate
ctx := context.TODO()
id := connection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "connectionValue")
payload := connection.ConnectionCreateOrUpdateParameters{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionClient.Delete
ctx := context.TODO()
id := connection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "connectionValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConnectionClient.Get
ctx := context.TODO()
id := connection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "connectionValue")
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: ConnectionClient.ListByAutomationAccount
ctx := context.TODO()
id := connection.NewAutomationAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue")
// alternatively `client.ListByAutomationAccount(ctx, id)` can be used to do batched pagination
items, err := client.ListByAutomationAccountComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConnectionClient.Update
ctx := context.TODO()
id := connection.NewConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "connectionValue")
payload := connection.ConnectionUpdateParameters{
// ...
}
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
NewAutomationAccountID returns a new AutomationAccountId struct.
No description provided by the author
NewConnectionID returns a new ConnectionId struct.
ParseAutomationAccountID parses 'input' into a AutomationAccountId.
ParseAutomationAccountIDInsensitively parses 'input' case-insensitively into a AutomationAccountId note: this method should only be used for API response data and not user input.
ParseConnectionID parses 'input' into a ConnectionId.
ParseConnectionIDInsensitively parses 'input' case-insensitively into a ConnectionId note: this method should only be used for API response data and not user input.
ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID.
ValidateConnectionID checks that 'input' can be parsed as a Connection ID.
# Structs
AutomationAccountId is a struct representing the Resource ID for a Automation Account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConnectionId is a struct representing the Resource ID for a Connection.
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