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/workloads/2023-04-01/sapdatabaseinstances
Documentation
The sapdatabaseinstances
SDK allows for interaction with the Azure Resource Manager Service workloads
(API Version 2023-04-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/workloads/2023-04-01/sapdatabaseinstances"
Client Initialization
client := sapdatabaseinstances.NewSAPDatabaseInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SAPDatabaseInstancesClient.Create
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
payload := sapdatabaseinstances.SAPDatabaseInstance{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SAPDatabaseInstancesClient.Delete
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SAPDatabaseInstancesClient.Get
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
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: SAPDatabaseInstancesClient.List
ctx := context.TODO()
id := sapdatabaseinstances.NewSapVirtualInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue")
// 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
}
Example Usage: SAPDatabaseInstancesClient.StartInstance
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
if err := client.StartInstanceThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SAPDatabaseInstancesClient.StopInstance
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
payload := sapdatabaseinstances.StopRequest{
// ...
}
if err := client.StopInstanceThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SAPDatabaseInstancesClient.Update
ctx := context.TODO()
id := sapdatabaseinstances.NewDatabaseInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "databaseInstanceValue")
payload := sapdatabaseinstances.UpdateSAPDatabaseInstanceRequest{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
# Functions
NewDatabaseInstanceID returns a new DatabaseInstanceId struct.
No description provided by the author
NewSapVirtualInstanceID returns a new SapVirtualInstanceId struct.
ParseDatabaseInstanceID parses 'input' into a DatabaseInstanceId.
ParseDatabaseInstanceIDInsensitively parses 'input' case-insensitively into a DatabaseInstanceId note: this method should only be used for API response data and not user input.
ParseSapVirtualInstanceID parses 'input' into a SapVirtualInstanceId.
ParseSapVirtualInstanceIDInsensitively parses 'input' case-insensitively into a SapVirtualInstanceId 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
ValidateDatabaseInstanceID checks that 'input' can be parsed as a Database Instance ID.
ValidateSapVirtualInstanceID checks that 'input' can be parsed as a Sap Virtual Instance 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
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
DatabaseInstanceId is a struct representing the Resource ID for a Database Instance.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SapVirtualInstanceId is a struct representing the Resource ID for a Sap Virtual Instance.
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
# Type aliases
No description provided by the author
No description provided by the author