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/sql/2023-02-01-preview/instancefailovergroups Documentation

The instancefailovergroups SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-01-preview).

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/sql/2023-02-01-preview/instancefailovergroups"

Client Initialization

client := instancefailovergroups.NewInstanceFailoverGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InstanceFailoverGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := instancefailovergroups.NewInstanceFailoverGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "instanceFailoverGroupValue")

payload := instancefailovergroups.InstanceFailoverGroup{
	// ...
}


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

Example Usage: InstanceFailoverGroupsClient.Delete

ctx := context.TODO()
id := instancefailovergroups.NewInstanceFailoverGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "instanceFailoverGroupValue")

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

Example Usage: InstanceFailoverGroupsClient.Failover

ctx := context.TODO()
id := instancefailovergroups.NewInstanceFailoverGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "instanceFailoverGroupValue")

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

Example Usage: InstanceFailoverGroupsClient.ForceFailoverAllowDataLoss

ctx := context.TODO()
id := instancefailovergroups.NewInstanceFailoverGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "instanceFailoverGroupValue")

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

Example Usage: InstanceFailoverGroupsClient.Get

ctx := context.TODO()
id := instancefailovergroups.NewInstanceFailoverGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "instanceFailoverGroupValue")

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: InstanceFailoverGroupsClient.ListByLocation

ctx := context.TODO()
id := instancefailovergroups.NewProviderLocationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue")

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

# Functions

NewInstanceFailoverGroupID returns a new InstanceFailoverGroupId struct.
No description provided by the author
NewProviderLocationID returns a new ProviderLocationId struct.
ParseInstanceFailoverGroupID parses 'input' into a InstanceFailoverGroupId.
ParseInstanceFailoverGroupIDInsensitively parses 'input' case-insensitively into a InstanceFailoverGroupId note: this method should only be used for API response data and not user input.
ParseProviderLocationID parses 'input' into a ProviderLocationId.
ParseProviderLocationIDInsensitively parses 'input' case-insensitively into a ProviderLocationId 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
No description provided by the author
ValidateInstanceFailoverGroupID checks that 'input' can be parsed as a Instance Failover Group ID.
ValidateProviderLocationID checks that 'input' can be parsed as a Provider Location 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

# 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
InstanceFailoverGroupId is a struct representing the Resource ID for a Instance Failover Group.
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
ProviderLocationId is a struct representing the Resource ID for a Provider Location.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author