configurationstores

package
v0.20220916.1081709 Latest Latest
Warning

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

Go to latest
Published: Sep 16, 2022 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/appconfiguration/2022-05-01/configurationstores Documentation

The configurationstores SDK allows for interaction with the Azure Resource Manager Service appconfiguration (API Version 2022-05-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/2022-05-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", "configStoreValue")

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", "configStoreValue")

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", "configStoreValue")

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", "configStoreValue")

// 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", "configStoreValue")

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", "configStoreValue")

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

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
	ConfigStoreName   string
}

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

func NewConfigurationStoreID

func NewConfigurationStoreID(subscriptionId string, resourceGroupName string, configStoreName 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

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 autorest.Client
	// contains filtered or unexported fields
}

func NewConfigurationStoresClientWithBaseURI

func NewConfigurationStoresClientWithBaseURI(endpoint string) ConfigurationStoresClient

func (ConfigurationStoresClient) Create

Create ...

func (ConfigurationStoresClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (ConfigurationStoresClient) Delete

Delete ...

func (ConfigurationStoresClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ConfigurationStoresClient) Get

Get ...

func (ConfigurationStoresClient) List

List ...

func (ConfigurationStoresClient) ListByResourceGroup

ListByResourceGroup ...

func (ConfigurationStoresClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (ConfigurationStoresClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ConfigurationStoresClient) ListComplete

ListComplete retrieves all of the results into a single object

func (ConfigurationStoresClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ConfigurationStoresClient) ListKeys

ListKeys ...

func (ConfigurationStoresClient) ListKeysComplete

ListKeysComplete retrieves all of the results into a single object

func (ConfigurationStoresClient) ListKeysCompleteMatchingPredicate

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

ListKeysCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ConfigurationStoresClient) RegenerateKey

RegenerateKey ...

func (ConfigurationStoresClient) Update

Update ...

func (ConfigurationStoresClient) UpdateThenPoll

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

type CreateMode

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

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type EncryptionProperties

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	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
	Model        *[]ConfigurationStore
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []ConfigurationStore
}

type ListKeysCompleteResult

type ListKeysCompleteResult struct {
	Items []ApiKey
}

type ListKeysOperationResponse

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ApiKey
	// contains filtered or unexported fields
}

func (ListKeysOperationResponse) HasMore

func (r ListKeysOperationResponse) HasMore() bool

func (ListKeysOperationResponse) LoadMore

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ConfigurationStore
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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

type PublicNetworkAccess

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

type RegenerateKeyOperationResponse

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	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       polling.LongRunningPoller
	HttpResponse *http.Response
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL