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/2020-01-01/serverkeys Documentation

The serverkeys SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2020-01-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/2020-01-01/serverkeys"

Client Initialization

client := serverkeys.NewServerKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerKeysClient.CreateOrUpdate

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

payload := serverkeys.ServerKey{
	// ...
}


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

Example Usage: ServerKeysClient.Delete

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

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

Example Usage: ServerKeysClient.Get

ctx := context.TODO()
id := serverkeys.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "keyValue")

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: ServerKeysClient.List

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

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

# Functions

NewKeyID returns a new KeyId struct.
NewServerID returns a new ServerId struct.
No description provided by the author
ParseKeyID parses 'input' into a KeyId.
ParseKeyIDInsensitively parses 'input' case-insensitively into a KeyId 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
ValidateKeyID checks that 'input' can be parsed as a Key ID.
ValidateServerID checks that 'input' can be parsed as a Server ID.

# Constants

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
KeyId is a struct representing the Resource ID for a Key.
No description provided by the author
No description provided by the author
No description provided by the author
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
No description provided by the author

# Type aliases

No description provided by the author