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/sql/2023-05-01-preview/syncagents
Documentation
The syncagents
SDK allows for interaction with the Azure Resource Manager Service sql
(API Version 2023-05-01-preview
).
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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/syncagents"
Client Initialization
client := syncagents.NewSyncAgentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SyncAgentsClient.CreateOrUpdate
ctx := context.TODO()
id := syncagents.NewSyncAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "syncAgentValue")
payload := syncagents.SyncAgent{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SyncAgentsClient.Delete
ctx := context.TODO()
id := syncagents.NewSyncAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "syncAgentValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SyncAgentsClient.GenerateKey
ctx := context.TODO()
id := syncagents.NewSyncAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "syncAgentValue")
read, err := client.GenerateKey(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SyncAgentsClient.Get
ctx := context.TODO()
id := syncagents.NewSyncAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "syncAgentValue")
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: SyncAgentsClient.ListByServer
ctx := context.TODO()
id := commonids.NewSqlServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue")
// alternatively `client.ListByServer(ctx, id)` can be used to do batched pagination
items, err := client.ListByServerComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: SyncAgentsClient.ListLinkedDatabases
ctx := context.TODO()
id := syncagents.NewSyncAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "syncAgentValue")
// alternatively `client.ListLinkedDatabases(ctx, id)` can be used to do batched pagination
items, err := client.ListLinkedDatabasesComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
NewSyncAgentID returns a new SyncAgentId struct.
No description provided by the author
ParseSyncAgentID parses 'input' into a SyncAgentId.
ParseSyncAgentIDInsensitively parses 'input' case-insensitively into a SyncAgentId 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
ValidateSyncAgentID checks that 'input' can be parsed as a Sync Agent 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
# 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
SyncAgentId is a struct representing the Resource ID for a Sync Agent.
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
# Type aliases
No description provided by the author
No description provided by the author