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/postgresql/2022-12-01/administrators
Documentation
The administrators
SDK allows for interaction with the Azure Resource Manager Service postgresql
(API Version 2022-12-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/postgresql/2022-12-01/administrators"
Client Initialization
client := administrators.NewAdministratorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AdministratorsClient.Create
ctx := context.TODO()
id := administrators.NewAdministratorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "objectIdValue")
payload := administrators.ActiveDirectoryAdministratorAdd{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: AdministratorsClient.Delete
ctx := context.TODO()
id := administrators.NewAdministratorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "objectIdValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: AdministratorsClient.Get
ctx := context.TODO()
id := administrators.NewAdministratorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "objectIdValue")
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: AdministratorsClient.ListByServer
ctx := context.TODO()
id := administrators.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")
// 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
}
# Functions
NewAdministratorID returns a new AdministratorId struct.
No description provided by the author
NewFlexibleServerID returns a new FlexibleServerId struct.
ParseAdministratorID parses 'input' into a AdministratorId.
ParseAdministratorIDInsensitively parses 'input' case-insensitively into a AdministratorId note: this method should only be used for API response data and not user input.
ParseFlexibleServerID parses 'input' into a FlexibleServerId.
ParseFlexibleServerIDInsensitively parses 'input' case-insensitively into a FlexibleServerId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateAdministratorID checks that 'input' can be parsed as a Administrator ID.
ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server 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
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
AdministratorId is a struct representing the Resource ID for a Administrator.
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
FlexibleServerId is a struct representing the Resource ID for a Flexible Server.
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