github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/syncgroups Documentation

The syncgroups 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/syncgroups"

Client Initialization

client := syncgroups.NewSyncGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SyncGroupsClient.CancelSync

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

read, err := client.CancelSync(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SyncGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

payload := syncgroups.SyncGroup{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: SyncGroupsClient.Delete

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: SyncGroupsClient.Get

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

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: SyncGroupsClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue")

// alternatively `client.ListByDatabase(ctx, id)` can be used to do batched pagination
items, err := client.ListByDatabaseComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SyncGroupsClient.ListHubSchemas

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

// alternatively `client.ListHubSchemas(ctx, id)` can be used to do batched pagination
items, err := client.ListHubSchemasComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SyncGroupsClient.ListLogs

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

// alternatively `client.ListLogs(ctx, id, syncgroups.DefaultListLogsOperationOptions())` can be used to do batched pagination
items, err := client.ListLogsComplete(ctx, id, syncgroups.DefaultListLogsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SyncGroupsClient.ListSyncDatabaseIds

ctx := context.TODO()
id := syncgroups.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.ListSyncDatabaseIds(ctx, id)` can be used to do batched pagination
items, err := client.ListSyncDatabaseIdsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: SyncGroupsClient.RefreshHubSchema

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

if err := client.RefreshHubSchemaThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: SyncGroupsClient.TriggerSync

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

read, err := client.TriggerSync(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: SyncGroupsClient.Update

ctx := context.TODO()
id := syncgroups.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "syncGroupValue")

payload := syncgroups.SyncGroup{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}