configurationstores

package
v0.20230516.1171524 Latest Latest
Warning

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

 Go to latest Published: May 16, 2023 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/appconfiguration/2023-03-01/configurationstores Documentation

The configurationstores 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/configurationstores"

Client Initialization

client := configurationstores.NewConfigurationStoresClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConfigurationStoresClient.Create

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

payload := configurationstores.ConfigurationStore{
	// ...
}


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

Example Usage: ConfigurationStoresClient.Delete

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

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

Example Usage: ConfigurationStoresClient.Get

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

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

ctx := context.TODO()
id := configurationstores.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// 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: ConfigurationStoresClient.ListByResourceGroup

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

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

Example Usage: ConfigurationStoresClient.ListKeys

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

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

Example Usage: ConfigurationStoresClient.RegenerateKey

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

payload := configurationstores.RegenerateKeyParameters{
	// ...
}


read, err := client.RegenerateKey(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ConfigurationStoresClient.Update

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

payload := configurationstores.ConfigurationStoreUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActionsRequired 

func PossibleValuesForActionsRequired() []string

func PossibleValuesForConnectionStatus 

func PossibleValuesForConnectionStatus() []string

func PossibleValuesForCreateMode 

func PossibleValuesForCreateMode() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []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

Types

type ActionsRequired 

type ActionsRequired string
const (
	ActionsRequiredNone     ActionsRequired = "None"
	ActionsRequiredRecreate ActionsRequired = "Recreate"
)

func (*ActionsRequired) UnmarshalJSON added in v0.20230503.1093249 

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

type ApiKey 

type ApiKey struct {
	ConnectionString *string `json:"connectionString,omitempty"`
	Id               *string `json:"id,omitempty"`
	LastModified     *string `json:"lastModified,omitempty"`
	Name             *string `json:"name,omitempty"`
	ReadOnly         *bool   `json:"readOnly,omitempty"`
	Value            *string `json:"value,omitempty"`
}

func (*ApiKey) GetLastModifiedAsTime 

func (o *ApiKey) GetLastModifiedAsTime() (*time.Time, error)

func (*ApiKey) SetLastModifiedAsTime 

func (o *ApiKey) SetLastModifiedAsTime(input time.Time)

type ApiKeyOperationPredicate 

type ApiKeyOperationPredicate struct {
	ConnectionString *string
	Id               *string
	LastModified     *string
	Name             *string
	ReadOnly         *bool
	Value            *string
}

func (ApiKeyOperationPredicate) Matches 

func (p ApiKeyOperationPredicate) Matches(input ApiKey) bool

type ConfigurationStore 

type ConfigurationStore struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ConfigurationStoreProperties      `json:"properties,omitempty"`
	Sku        Sku                                `json:"sku"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

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) 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 ConfigurationStoreOperationPredicate 

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

func (ConfigurationStoreOperationPredicate) Matches 

func (p ConfigurationStoreOperationPredicate) Matches(input ConfigurationStore) bool

type ConfigurationStoreProperties 

type ConfigurationStoreProperties struct {
	CreateMode                 *CreateMode                           `json:"createMode,omitempty"`
	CreationDate               *string                               `json:"creationDate,omitempty"`
	DisableLocalAuth           *bool                                 `json:"disableLocalAuth,omitempty"`
	EnablePurgeProtection      *bool                                 `json:"enablePurgeProtection,omitempty"`
	Encryption                 *EncryptionProperties                 `json:"encryption,omitempty"`
	Endpoint                   *string                               `json:"endpoint,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnectionReference `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningState                    `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess                  `json:"publicNetworkAccess,omitempty"`
	SoftDeleteRetentionInDays  *int64                                `json:"softDeleteRetentionInDays,omitempty"`
}

func (*ConfigurationStoreProperties) GetCreationDateAsTime 

func (o *ConfigurationStoreProperties) GetCreationDateAsTime() (*time.Time, error)

func (*ConfigurationStoreProperties) SetCreationDateAsTime 

func (o *ConfigurationStoreProperties) SetCreationDateAsTime(input time.Time)

type ConfigurationStorePropertiesUpdateParameters 

type ConfigurationStorePropertiesUpdateParameters struct {
	DisableLocalAuth      *bool                 `json:"disableLocalAuth,omitempty"`
	EnablePurgeProtection *bool                 `json:"enablePurgeProtection,omitempty"`
	Encryption            *EncryptionProperties `json:"encryption,omitempty"`
	PublicNetworkAccess   *PublicNetworkAccess  `json:"publicNetworkAccess,omitempty"`
}

type ConfigurationStoreUpdateParameters 

type ConfigurationStoreUpdateParameters struct {
	Identity   *identity.SystemAndUserAssignedMap            `json:"identity,omitempty"`
	Properties *ConfigurationStorePropertiesUpdateParameters `json:"properties,omitempty"`
	Sku        *Sku                                          `json:"sku,omitempty"`
	Tags       *map[string]string                            `json:"tags,omitempty"`
}

type ConfigurationStoresClient 

type ConfigurationStoresClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationStoresClientWithBaseURI 

func NewConfigurationStoresClientWithBaseURI(api environments.Api) (*ConfigurationStoresClient, error)

func (ConfigurationStoresClient) Create 

func (c ConfigurationStoresClient) Create(ctx context.Context, id ConfigurationStoreId, input ConfigurationStore) (result CreateOperationResponse, err error)

Create ...

func (ConfigurationStoresClient) CreateThenPoll 

func (c ConfigurationStoresClient) CreateThenPoll(ctx context.Context, id ConfigurationStoreId, input ConfigurationStore) error

CreateThenPoll performs Create then polls until it's completed

func (ConfigurationStoresClient) Delete 

func (c ConfigurationStoresClient) Delete(ctx context.Context, id ConfigurationStoreId) (result DeleteOperationResponse, err error)

Delete ...

func (ConfigurationStoresClient) DeleteThenPoll 

func (c ConfigurationStoresClient) DeleteThenPoll(ctx context.Context, id ConfigurationStoreId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ConfigurationStoresClient) Get 

func (c ConfigurationStoresClient) Get(ctx context.Context, id ConfigurationStoreId) (result GetOperationResponse, err error)

Get ...

func (ConfigurationStoresClient) List 

func (c ConfigurationStoresClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ConfigurationStoresClient) ListByResourceGroup 

func (c ConfigurationStoresClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ConfigurationStoresClient) ListByResourceGroupComplete 

func (c ConfigurationStoresClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ConfigurationStoresClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ConfigurationStoresClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ConfigurationStoreOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationStoresClient) ListComplete 

func (c ConfigurationStoresClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ConfigurationStoresClient) ListCompleteMatchingPredicate 

func (c ConfigurationStoresClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ConfigurationStoreOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationStoresClient) ListKeys 

func (c ConfigurationStoresClient) ListKeys(ctx context.Context, id ConfigurationStoreId) (result ListKeysOperationResponse, err error)

ListKeys ...

func (ConfigurationStoresClient) ListKeysComplete 

func (c ConfigurationStoresClient) ListKeysComplete(ctx context.Context, id ConfigurationStoreId) (ListKeysCompleteResult, error)

ListKeysComplete retrieves all the results into a single object

func (ConfigurationStoresClient) ListKeysCompleteMatchingPredicate 

func (c ConfigurationStoresClient) ListKeysCompleteMatchingPredicate(ctx context.Context, id ConfigurationStoreId, predicate ApiKeyOperationPredicate) (result ListKeysCompleteResult, err error)

ListKeysCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationStoresClient) RegenerateKey 

func (c ConfigurationStoresClient) RegenerateKey(ctx context.Context, id ConfigurationStoreId, input RegenerateKeyParameters) (result RegenerateKeyOperationResponse, err error)

RegenerateKey ...

func (ConfigurationStoresClient) Update 

func (c ConfigurationStoresClient) Update(ctx context.Context, id ConfigurationStoreId, input ConfigurationStoreUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (ConfigurationStoresClient) UpdateThenPoll 

func (c ConfigurationStoresClient) UpdateThenPoll(ctx context.Context, id ConfigurationStoreId, input ConfigurationStoreUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusApproved     ConnectionStatus = "Approved"
	ConnectionStatusDisconnected ConnectionStatus = "Disconnected"
	ConnectionStatusPending      ConnectionStatus = "Pending"
	ConnectionStatusRejected     ConnectionStatus = "Rejected"
)

func (*ConnectionStatus) UnmarshalJSON added in v0.20230503.1093249 

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

type CreateMode 

type CreateMode string
const (
	CreateModeDefault CreateMode = "Default"
	CreateModeRecover CreateMode = "Recover"
)

func (*CreateMode) UnmarshalJSON added in v0.20230503.1093249 

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

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 EncryptionProperties 

type EncryptionProperties struct {
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type GetOperationResponse 

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

type KeyVaultProperties 

type KeyVaultProperties struct {
	IdentityClientId *string `json:"identityClientId,omitempty"`
	KeyIdentifier    *string `json:"keyIdentifier,omitempty"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []ConfigurationStore
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConfigurationStore
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []ConfigurationStore
}

type ListKeysCompleteResult 

type ListKeysCompleteResult struct {
	Items []ApiKey
}

type ListKeysOperationResponse 

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiKey
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConfigurationStore
}

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                  `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *ProvisioningState                `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionReference 

type PrivateEndpointConnectionReference struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *ActionsRequired  `json:"actionsRequired,omitempty"`
	Description     *string           `json:"description,omitempty"`
	Status          *ConnectionStatus `json:"status,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230503.1093249 

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

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON added in v0.20230503.1093249 

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

type RegenerateKeyOperationResponse 

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiKey
}

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	Id *string `json:"id,omitempty"`
}

type Sku 

type Sku struct {
	Name string `json:"name"`
}

type UpdateOperationResponse 

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

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.