replicas

package
v0.20240112.1112256 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 12, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForReplicaProvisioningState 

func PossibleValuesForReplicaProvisioningState() []string

func ValidateConfigurationStoreID 

func ValidateConfigurationStoreID(input interface{}, key string) (warnings []string, errors []error)

ValidateConfigurationStoreID checks that 'input' can be parsed as a Configuration Store ID

func ValidateReplicaID 

func ValidateReplicaID(input interface{}, key string) (warnings []string, errors []error)

ValidateReplicaID checks that 'input' can be parsed as a Replica ID

Types

type ConfigurationStoreId 

type ConfigurationStoreId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ConfigurationStoreName string
}

ConfigurationStoreId is a struct representing the Resource ID for a Configuration Store

func NewConfigurationStoreID 

func NewConfigurationStoreID(subscriptionId string, resourceGroupName string, configurationStoreName string) ConfigurationStoreId

NewConfigurationStoreID returns a new ConfigurationStoreId struct

func ParseConfigurationStoreID 

func ParseConfigurationStoreID(input string) (*ConfigurationStoreId, error)

ParseConfigurationStoreID parses 'input' into a ConfigurationStoreId

func ParseConfigurationStoreIDInsensitively 

func ParseConfigurationStoreIDInsensitively(input string) (*ConfigurationStoreId, error)

ParseConfigurationStoreIDInsensitively parses 'input' case-insensitively into a ConfigurationStoreId note: this method should only be used for API response data and not user input

func (*ConfigurationStoreId) FromParseResult added in v0.20231127.1171502 

func (id *ConfigurationStoreId) FromParseResult(input resourceids.ParseResult) error

func (ConfigurationStoreId) ID 

func (id ConfigurationStoreId) ID() string

ID returns the formatted Configuration Store ID

func (ConfigurationStoreId) Segments 

func (id ConfigurationStoreId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Configuration Store ID

func (ConfigurationStoreId) String 

func (id ConfigurationStoreId) String() string

String returns a human-readable description of this Configuration Store ID

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Replica
}

type ListByConfigurationStoreCompleteResult 

type ListByConfigurationStoreCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Replica
}

type ListByConfigurationStoreOperationResponse 

type ListByConfigurationStoreOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Replica
}

type Replica 

type Replica struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ReplicaProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ReplicaId 

type ReplicaId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ConfigurationStoreName string
	ReplicaName            string
}

ReplicaId is a struct representing the Resource ID for a Replica

func NewReplicaID 

func NewReplicaID(subscriptionId string, resourceGroupName string, configurationStoreName string, replicaName string) ReplicaId

NewReplicaID returns a new ReplicaId struct

func ParseReplicaID 

func ParseReplicaID(input string) (*ReplicaId, error)

ParseReplicaID parses 'input' into a ReplicaId

func ParseReplicaIDInsensitively 

func ParseReplicaIDInsensitively(input string) (*ReplicaId, error)

ParseReplicaIDInsensitively parses 'input' case-insensitively into a ReplicaId note: this method should only be used for API response data and not user input

func (*ReplicaId) FromParseResult added in v0.20231127.1171502 

func (id *ReplicaId) FromParseResult(input resourceids.ParseResult) error

func (ReplicaId) ID 

func (id ReplicaId) ID() string

ID returns the formatted Replica ID

func (ReplicaId) Segments 

func (id ReplicaId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Replica ID

func (ReplicaId) String 

func (id ReplicaId) String() string

String returns a human-readable description of this Replica ID

type ReplicaOperationPredicate 

type ReplicaOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ReplicaOperationPredicate) Matches 

func (p ReplicaOperationPredicate) Matches(input Replica) bool

type ReplicaProperties 

type ReplicaProperties struct {
	Endpoint          *string                   `json:"endpoint,omitempty"`
	ProvisioningState *ReplicaProvisioningState `json:"provisioningState,omitempty"`
}

type ReplicaProvisioningState 

type ReplicaProvisioningState string
const (
	ReplicaProvisioningStateCanceled  ReplicaProvisioningState = "Canceled"
	ReplicaProvisioningStateCreating  ReplicaProvisioningState = "Creating"
	ReplicaProvisioningStateDeleting  ReplicaProvisioningState = "Deleting"
	ReplicaProvisioningStateFailed    ReplicaProvisioningState = "Failed"
	ReplicaProvisioningStateSucceeded ReplicaProvisioningState = "Succeeded"
)

func (*ReplicaProvisioningState) UnmarshalJSON added in v0.20230503.1093249 

func (s *ReplicaProvisioningState) UnmarshalJSON(bytes []byte) error

type ReplicasClient 

type ReplicasClient struct {
	Client *resourcemanager.Client
}

func NewReplicasClientWithBaseURI 

func NewReplicasClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicasClient, error)

func (ReplicasClient) Create 

func (c ReplicasClient) Create(ctx context.Context, id ReplicaId, input Replica) (result CreateOperationResponse, err error)

Create ...

func (ReplicasClient) CreateThenPoll 

func (c ReplicasClient) CreateThenPoll(ctx context.Context, id ReplicaId, input Replica) error

CreateThenPoll performs Create then polls until it's completed

func (ReplicasClient) Delete 

func (c ReplicasClient) Delete(ctx context.Context, id ReplicaId) (result DeleteOperationResponse, err error)

Delete ...

func (ReplicasClient) DeleteThenPoll 

func (c ReplicasClient) DeleteThenPoll(ctx context.Context, id ReplicaId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ReplicasClient) Get 

func (c ReplicasClient) Get(ctx context.Context, id ReplicaId) (result GetOperationResponse, err error)

Get ...

func (ReplicasClient) ListByConfigurationStore 

func (c ReplicasClient) ListByConfigurationStore(ctx context.Context, id ConfigurationStoreId) (result ListByConfigurationStoreOperationResponse, err error)

ListByConfigurationStore ...

func (ReplicasClient) ListByConfigurationStoreComplete 

func (c ReplicasClient) ListByConfigurationStoreComplete(ctx context.Context, id ConfigurationStoreId) (ListByConfigurationStoreCompleteResult, error)

ListByConfigurationStoreComplete retrieves all the results into a single object

func (ReplicasClient) ListByConfigurationStoreCompleteMatchingPredicate 

func (c ReplicasClient) ListByConfigurationStoreCompleteMatchingPredicate(ctx context.Context, id ConfigurationStoreId, predicate ReplicaOperationPredicate) (result ListByConfigurationStoreCompleteResult, err error)

ListByConfigurationStoreCompleteMatchingPredicate retrieves all the results and then applies the predicate

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.