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/synapse/2021-06-01/sqlpools
Documentation
The sqlpools
SDK allows for interaction with the Azure Resource Manager Service synapse
(API Version 2021-06-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/synapse/2021-06-01/sqlpools"
Client Initialization
client := sqlpools.NewSqlPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SqlPoolsClient.Create
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
payload := sqlpools.SqlPool{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SqlPoolsClient.Delete
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SqlPoolsClient.Get
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
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: SqlPoolsClient.ListByWorkspace
ctx := context.TODO()
id := sqlpools.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")
// alternatively `client.ListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.ListByWorkspaceComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: SqlPoolsClient.Pause
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
if err := client.PauseThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SqlPoolsClient.Resume
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
if err := client.ResumeThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SqlPoolsClient.SqlPoolMetadataSyncConfigsCreate
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
payload := sqlpools.MetadataSyncConfig{
// ...
}
read, err := client.SqlPoolMetadataSyncConfigsCreate(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SqlPoolsClient.SqlPoolMetadataSyncConfigsGet
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
read, err := client.SqlPoolMetadataSyncConfigsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SqlPoolsClient.Update
ctx := context.TODO()
id := sqlpools.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")
payload := sqlpools.SqlPoolPatchInfo{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
# Functions
NewSqlPoolID returns a new SqlPoolId struct.
No description provided by the author
NewWorkspaceID returns a new WorkspaceId struct.
ParseSqlPoolID parses 'input' into a SqlPoolId.
ParseSqlPoolIDInsensitively parses 'input' case-insensitively into a SqlPoolId note: this method should only be used for API response data and not user input.
ParseWorkspaceID parses 'input' into a WorkspaceId.
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId 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
ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID.
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace 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
# 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
SqlPoolId is a struct representing the Resource ID for a Sql Pool.
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
WorkspaceId is a struct representing the Resource ID for a Workspace.
# Type aliases
No description provided by the author
No description provided by the author