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/postgresqlhsc/2022-11-08/configurations
Documentation
The configurations
SDK allows for interaction with the Azure Resource Manager Service postgresqlhsc
(API Version 2022-11-08
).
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/postgresqlhsc/2022-11-08/configurations"
Client Initialization
client := configurations.NewConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ConfigurationsClient.Get
ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "configurationValue")
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: ConfigurationsClient.GetCoordinator
ctx := context.TODO()
id := configurations.NewCoordinatorConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "coordinatorConfigurationValue")
read, err := client.GetCoordinator(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConfigurationsClient.GetNode
ctx := context.TODO()
id := configurations.NewNodeConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "nodeConfigurationValue")
read, err := client.GetNode(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConfigurationsClient.ListByCluster
ctx := context.TODO()
id := configurations.NewServerGroupsv2ID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value")
// alternatively `client.ListByCluster(ctx, id)` can be used to do batched pagination
items, err := client.ListByClusterComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConfigurationsClient.ListByServer
ctx := context.TODO()
id := configurations.NewServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "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: ConfigurationsClient.UpdateOnCoordinator
ctx := context.TODO()
id := configurations.NewCoordinatorConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "coordinatorConfigurationValue")
payload := configurations.ServerConfiguration{
// ...
}
if err := client.UpdateOnCoordinatorThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ConfigurationsClient.UpdateOnNode
ctx := context.TODO()
id := configurations.NewNodeConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "nodeConfigurationValue")
payload := configurations.ServerConfiguration{
// ...
}
if err := client.UpdateOnNodeThenPoll(ctx, id, payload); err != nil {
// handle the error
}
# Functions
NewConfigurationID returns a new ConfigurationId struct.
No description provided by the author
NewCoordinatorConfigurationID returns a new CoordinatorConfigurationId struct.
NewNodeConfigurationID returns a new NodeConfigurationId struct.
NewServerGroupsv2ID returns a new ServerGroupsv2Id struct.
NewServerID returns a new ServerId struct.
ParseConfigurationID parses 'input' into a ConfigurationId.
ParseConfigurationIDInsensitively parses 'input' case-insensitively into a ConfigurationId note: this method should only be used for API response data and not user input.
ParseCoordinatorConfigurationID parses 'input' into a CoordinatorConfigurationId.
ParseCoordinatorConfigurationIDInsensitively parses 'input' case-insensitively into a CoordinatorConfigurationId note: this method should only be used for API response data and not user input.
ParseNodeConfigurationID parses 'input' into a NodeConfigurationId.
ParseNodeConfigurationIDInsensitively parses 'input' case-insensitively into a NodeConfigurationId note: this method should only be used for API response data and not user input.
ParseServerGroupsv2ID parses 'input' into a ServerGroupsv2Id.
ParseServerGroupsv2IDInsensitively parses 'input' case-insensitively into a ServerGroupsv2Id note: this method should only be used for API response data and not user input.
ParseServerID parses 'input' into a ServerId.
ParseServerIDInsensitively parses 'input' case-insensitively into a ServerId 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
No description provided by the author
ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID.
ValidateCoordinatorConfigurationID checks that 'input' can be parsed as a Coordinator Configuration ID.
ValidateNodeConfigurationID checks that 'input' can be parsed as a Node Configuration ID.
ValidateServerGroupsv2ID checks that 'input' can be parsed as a Server Groupsv 2 ID.
ValidateServerID checks that 'input' can be parsed as a 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
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
ConfigurationId is a struct representing the Resource ID for a Configuration.
No description provided by the author
No description provided by the author
No description provided by the author
CoordinatorConfigurationId is a struct representing the Resource ID for a Coordinator Configuration.
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
NodeConfigurationId is a struct representing the Resource ID for a Node Configuration.
No description provided by the author
No description provided by the author
No description provided by the author
ServerGroupsv2Id is a struct representing the Resource ID for a Server Groupsv 2.
ServerId is a struct representing the Resource ID for a Server.
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
No description provided by the author