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/appconfiguration/2023-03-01/replicas Documentation

The replicas SDK allows for interaction with the Azure Resource Manager Service appconfiguration (API Version 2023-03-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/appconfiguration/2023-03-01/replicas"

Client Initialization

client := replicas.NewReplicasClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicasClient.Create

ctx := context.TODO()
id := replicas.NewReplicaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationStoreValue", "replicaValue")

payload := replicas.Replica{
	// ...
}


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

Example Usage: ReplicasClient.Delete

ctx := context.TODO()
id := replicas.NewReplicaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationStoreValue", "replicaValue")

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

Example Usage: ReplicasClient.Get

ctx := context.TODO()
id := replicas.NewReplicaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationStoreValue", "replicaValue")

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: ReplicasClient.ListByConfigurationStore

ctx := context.TODO()
id := replicas.NewConfigurationStoreID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationStoreValue")

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

# Functions

NewConfigurationStoreID returns a new ConfigurationStoreId struct.
NewReplicaID returns a new ReplicaId struct.
No description provided by the author
ParseConfigurationStoreID parses 'input' into a ConfigurationStoreId.
ParseConfigurationStoreIDInsensitively parses 'input' case-insensitively into a ConfigurationStoreId note: this method should only be used for API response data and not user input.
ParseReplicaID parses 'input' into a ReplicaId.
ParseReplicaIDInsensitively parses 'input' case-insensitively into a ReplicaId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateConfigurationStoreID checks that 'input' can be parsed as a Configuration Store ID.
ValidateReplicaID checks that 'input' can be parsed as a Replica 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

# Structs

ConfigurationStoreId is a struct representing the Resource ID for a Configuration Store.
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
ReplicaId is a struct representing the Resource ID for a Replica.
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