appconfiguration

package
v51.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 4, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package appconfiguration implements the Azure ARM Appconfiguration service API version 2019-02-01-preview.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Appconfiguration
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIKey 

type APIKey struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The key ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; A name for the key describing its usage.
	Name *string `json:"name,omitempty"`
	// Value - READ-ONLY; The value of the key that is used for authentication purposes.
	Value *string `json:"value,omitempty"`
	// ConnectionString - READ-ONLY; A connection string that can be used by supporting clients for authentication.
	ConnectionString *string `json:"connectionString,omitempty"`
	// LastModified - READ-ONLY; The last time any of the key's properties were modified.
	LastModified *date.Time `json:"lastModified,omitempty"`
	// ReadOnly - READ-ONLY; Whether this key can only be used for read operations.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

APIKey an API key used for authenticating with a configuration store endpoint.

type APIKeyListResult 

type APIKeyListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection value.
	Value *[]APIKey `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`
}

APIKeyListResult the result of a request to list API keys.

func (APIKeyListResult) IsEmpty 

func (aklr APIKeyListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIKeyListResultIterator 

type APIKeyListResultIterator struct {
	// contains filtered or unexported fields
}

APIKeyListResultIterator provides access to a complete listing of APIKey values.

func NewAPIKeyListResultIterator 

func NewAPIKeyListResultIterator(page APIKeyListResultPage) APIKeyListResultIterator

Creates a new instance of the APIKeyListResultIterator type.

func (*APIKeyListResultIterator) Next 

func (iter *APIKeyListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*APIKeyListResultIterator) NextWithContext 

func (iter *APIKeyListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (APIKeyListResultIterator) NotDone 

func (iter APIKeyListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (APIKeyListResultIterator) Response 

func (iter APIKeyListResultIterator) Response() APIKeyListResult

Response returns the raw server response from the last page request.

func (APIKeyListResultIterator) Value 

func (iter APIKeyListResultIterator) Value() APIKey

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type APIKeyListResultPage 

type APIKeyListResultPage struct {
	// contains filtered or unexported fields
}

APIKeyListResultPage contains a page of APIKey values.

func NewAPIKeyListResultPage 

func NewAPIKeyListResultPage(cur APIKeyListResult, getNextPage func(context.Context, APIKeyListResult) (APIKeyListResult, error)) APIKeyListResultPage

Creates a new instance of the APIKeyListResultPage type.

func (*APIKeyListResultPage) Next 

func (page *APIKeyListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*APIKeyListResultPage) NextWithContext 

func (page *APIKeyListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (APIKeyListResultPage) NotDone 

func (page APIKeyListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (APIKeyListResultPage) Response 

func (page APIKeyListResultPage) Response() APIKeyListResult

Response returns the raw server response from the last page request.

func (APIKeyListResultPage) Values 

func (page APIKeyListResultPage) Values() []APIKey

Values returns the slice of values for the current page or nil if there are no values.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Appconfiguration.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckNameAvailabilityParameters 

type CheckNameAvailabilityParameters struct {
	// Name - The name to check for availability.
	Name *string `json:"name,omitempty"`
	// Type - The resource type to check for name availability.
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityParameters parameters used for checking whether a resource name is available.

type ConfigurationStore 

type ConfigurationStore struct {
	autorest.Response `json:"-"`
	// ConfigurationStoreProperties - The properties of a configuration store.
	*ConfigurationStoreProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource. This cannot be changed after the resource is created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

ConfigurationStore the configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.

func (ConfigurationStore) MarshalJSON 

func (cs ConfigurationStore) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ConfigurationStore.

func (*ConfigurationStore) UnmarshalJSON 

func (cs *ConfigurationStore) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ConfigurationStore struct.

type ConfigurationStoreListResult 

type ConfigurationStoreListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection value.
	Value *[]ConfigurationStore `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`
}

ConfigurationStoreListResult the result of a request to list configuration stores.

func (ConfigurationStoreListResult) IsEmpty 

func (cslr ConfigurationStoreListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ConfigurationStoreListResultIterator 

type ConfigurationStoreListResultIterator struct {
	// contains filtered or unexported fields
}

ConfigurationStoreListResultIterator provides access to a complete listing of ConfigurationStore values.

func NewConfigurationStoreListResultIterator 

func NewConfigurationStoreListResultIterator(page ConfigurationStoreListResultPage) ConfigurationStoreListResultIterator

Creates a new instance of the ConfigurationStoreListResultIterator type.

func (*ConfigurationStoreListResultIterator) Next 

func (iter *ConfigurationStoreListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ConfigurationStoreListResultIterator) NextWithContext 

func (iter *ConfigurationStoreListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ConfigurationStoreListResultIterator) NotDone 

func (iter ConfigurationStoreListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ConfigurationStoreListResultIterator) Response 

func (iter ConfigurationStoreListResultIterator) Response() ConfigurationStoreListResult

Response returns the raw server response from the last page request.

func (ConfigurationStoreListResultIterator) Value 

func (iter ConfigurationStoreListResultIterator) Value() ConfigurationStore

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ConfigurationStoreListResultPage 

type ConfigurationStoreListResultPage struct {
	// contains filtered or unexported fields
}

ConfigurationStoreListResultPage contains a page of ConfigurationStore values.

func NewConfigurationStoreListResultPage 

func NewConfigurationStoreListResultPage(cur ConfigurationStoreListResult, getNextPage func(context.Context, ConfigurationStoreListResult) (ConfigurationStoreListResult, error)) ConfigurationStoreListResultPage

Creates a new instance of the ConfigurationStoreListResultPage type.

func (*ConfigurationStoreListResultPage) Next 

func (page *ConfigurationStoreListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ConfigurationStoreListResultPage) NextWithContext 

func (page *ConfigurationStoreListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ConfigurationStoreListResultPage) NotDone 

func (page ConfigurationStoreListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ConfigurationStoreListResultPage) Response 

func (page ConfigurationStoreListResultPage) Response() ConfigurationStoreListResult

Response returns the raw server response from the last page request.

func (ConfigurationStoreListResultPage) Values 

func (page ConfigurationStoreListResultPage) Values() []ConfigurationStore

Values returns the slice of values for the current page or nil if there are no values.

type ConfigurationStoreProperties 

type ConfigurationStoreProperties struct {
	// ProvisioningState - READ-ONLY; The provisioning state of the configuration store. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// CreationDate - READ-ONLY; The creation date of configuration store.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// Endpoint - READ-ONLY; The DNS endpoint where the configuration store API will be available.
	Endpoint *string `json:"endpoint,omitempty"`
}

ConfigurationStoreProperties the properties of a configuration store.

type ConfigurationStoreUpdateParameters 

type ConfigurationStoreUpdateParameters struct {
	// Properties - The properties for updating a configuration store.
	Properties interface{} `json:"properties,omitempty"`
	// Tags - The ARM resource tags.
	Tags map[string]*string `json:"tags"`
}

ConfigurationStoreUpdateParameters the parameters for updating a configuration store.

func (ConfigurationStoreUpdateParameters) MarshalJSON 

func (csup ConfigurationStoreUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ConfigurationStoreUpdateParameters.

type ConfigurationStoresClient 

type ConfigurationStoresClient struct {
	BaseClient
}

ConfigurationStoresClient is the client for the ConfigurationStores methods of the Appconfiguration service.

func NewConfigurationStoresClient 

func NewConfigurationStoresClient(subscriptionID string) ConfigurationStoresClient

NewConfigurationStoresClient creates an instance of the ConfigurationStoresClient client.

func NewConfigurationStoresClientWithBaseURI 

func NewConfigurationStoresClientWithBaseURI(baseURI string, subscriptionID string) ConfigurationStoresClient

NewConfigurationStoresClientWithBaseURI creates an instance of the ConfigurationStoresClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ConfigurationStoresClient) Create 

func (client ConfigurationStoresClient) Create(ctx context.Context, resourceGroupName string, configStoreName string, configStoreCreationParameters ConfigurationStore) (result ConfigurationStoresCreateFuture, err error)

Create creates a configuration store with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store. configStoreCreationParameters - the parameters for creating a configuration store.

func (ConfigurationStoresClient) CreatePreparer 

func (client ConfigurationStoresClient) CreatePreparer(ctx context.Context, resourceGroupName string, configStoreName string, configStoreCreationParameters ConfigurationStore) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ConfigurationStoresClient) CreateResponder 

func (client ConfigurationStoresClient) CreateResponder(resp *http.Response) (result ConfigurationStore, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) CreateSender 

func (client ConfigurationStoresClient) CreateSender(req *http.Request) (future ConfigurationStoresCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) Delete 

func (client ConfigurationStoresClient) Delete(ctx context.Context, resourceGroupName string, configStoreName string) (result ConfigurationStoresDeleteFuture, err error)

Delete deletes a configuration store. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store.

func (ConfigurationStoresClient) DeletePreparer 

func (client ConfigurationStoresClient) DeletePreparer(ctx context.Context, resourceGroupName string, configStoreName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ConfigurationStoresClient) DeleteResponder 

func (client ConfigurationStoresClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) DeleteSender 

func (client ConfigurationStoresClient) DeleteSender(req *http.Request) (future ConfigurationStoresDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) Get 

func (client ConfigurationStoresClient) Get(ctx context.Context, resourceGroupName string, configStoreName string) (result ConfigurationStore, err error)

Get gets the properties of the specified configuration store. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store.

func (ConfigurationStoresClient) GetPreparer 

func (client ConfigurationStoresClient) GetPreparer(ctx context.Context, resourceGroupName string, configStoreName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ConfigurationStoresClient) GetResponder 

func (client ConfigurationStoresClient) GetResponder(resp *http.Response) (result ConfigurationStore, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) GetSender 

func (client ConfigurationStoresClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) List 

func (client ConfigurationStoresClient) List(ctx context.Context, skipToken string) (result ConfigurationStoreListResultPage, err error)

List lists the configuration stores for a given subscription. Parameters: skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ConfigurationStoresClient) ListByResourceGroup 

func (client ConfigurationStoresClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result ConfigurationStoreListResultPage, err error)

ListByResourceGroup lists the configuration stores for a given resource group. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ConfigurationStoresClient) ListByResourceGroupComplete 

func (client ConfigurationStoresClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skipToken string) (result ConfigurationStoreListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ConfigurationStoresClient) ListByResourceGroupPreparer 

func (client ConfigurationStoresClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, skipToken string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ConfigurationStoresClient) ListByResourceGroupResponder 

func (client ConfigurationStoresClient) ListByResourceGroupResponder(resp *http.Response) (result ConfigurationStoreListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) ListByResourceGroupSender 

func (client ConfigurationStoresClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) ListComplete 

func (client ConfigurationStoresClient) ListComplete(ctx context.Context, skipToken string) (result ConfigurationStoreListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ConfigurationStoresClient) ListKeyValue 

func (client ConfigurationStoresClient) ListKeyValue(ctx context.Context, resourceGroupName string, configStoreName string, listKeyValueParameters ListKeyValueParameters) (result KeyValue, err error)

ListKeyValue lists a configuration store key-value. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store. listKeyValueParameters - the parameters for retrieving a key-value.

func (ConfigurationStoresClient) ListKeyValuePreparer 

func (client ConfigurationStoresClient) ListKeyValuePreparer(ctx context.Context, resourceGroupName string, configStoreName string, listKeyValueParameters ListKeyValueParameters) (*http.Request, error)

ListKeyValuePreparer prepares the ListKeyValue request.

func (ConfigurationStoresClient) ListKeyValueResponder 

func (client ConfigurationStoresClient) ListKeyValueResponder(resp *http.Response) (result KeyValue, err error)

ListKeyValueResponder handles the response to the ListKeyValue request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) ListKeyValueSender 

func (client ConfigurationStoresClient) ListKeyValueSender(req *http.Request) (*http.Response, error)

ListKeyValueSender sends the ListKeyValue request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) ListKeys 

func (client ConfigurationStoresClient) ListKeys(ctx context.Context, resourceGroupName string, configStoreName string, skipToken string) (result APIKeyListResultPage, err error)

ListKeys lists the access key for the specified configuration store. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store. skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (ConfigurationStoresClient) ListKeysComplete 

func (client ConfigurationStoresClient) ListKeysComplete(ctx context.Context, resourceGroupName string, configStoreName string, skipToken string) (result APIKeyListResultIterator, err error)

ListKeysComplete enumerates all values, automatically crossing page boundaries as required.

func (ConfigurationStoresClient) ListKeysPreparer 

func (client ConfigurationStoresClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, configStoreName string, skipToken string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (ConfigurationStoresClient) ListKeysResponder 

func (client ConfigurationStoresClient) ListKeysResponder(resp *http.Response) (result APIKeyListResult, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) ListKeysSender 

func (client ConfigurationStoresClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) ListPreparer 

func (client ConfigurationStoresClient) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (ConfigurationStoresClient) ListResponder 

func (client ConfigurationStoresClient) ListResponder(resp *http.Response) (result ConfigurationStoreListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) ListSender 

func (client ConfigurationStoresClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) RegenerateKey 

func (client ConfigurationStoresClient) RegenerateKey(ctx context.Context, resourceGroupName string, configStoreName string, regenerateKeyParameters RegenerateKeyParameters) (result APIKey, err error)

RegenerateKey regenerates an access key for the specified configuration store. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store. regenerateKeyParameters - the parameters for regenerating an access key.

func (ConfigurationStoresClient) RegenerateKeyPreparer 

func (client ConfigurationStoresClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, configStoreName string, regenerateKeyParameters RegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (ConfigurationStoresClient) RegenerateKeyResponder 

func (client ConfigurationStoresClient) RegenerateKeyResponder(resp *http.Response) (result APIKey, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) RegenerateKeySender 

func (client ConfigurationStoresClient) RegenerateKeySender(req *http.Request) (*http.Response, error)

RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.

func (ConfigurationStoresClient) Update 

func (client ConfigurationStoresClient) Update(ctx context.Context, resourceGroupName string, configStoreName string, configStoreUpdateParameters ConfigurationStoreUpdateParameters) (result ConfigurationStoresUpdateFuture, err error)

Update updates a configuration store with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. configStoreName - the name of the configuration store. configStoreUpdateParameters - the parameters for updating a configuration store.

func (ConfigurationStoresClient) UpdatePreparer 

func (client ConfigurationStoresClient) UpdatePreparer(ctx context.Context, resourceGroupName string, configStoreName string, configStoreUpdateParameters ConfigurationStoreUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ConfigurationStoresClient) UpdateResponder 

func (client ConfigurationStoresClient) UpdateResponder(resp *http.Response) (result ConfigurationStore, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ConfigurationStoresClient) UpdateSender 

func (client ConfigurationStoresClient) UpdateSender(req *http.Request) (future ConfigurationStoresUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ConfigurationStoresCreateFuture 

type ConfigurationStoresCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ConfigurationStoresClient) (ConfigurationStore, error)
}

ConfigurationStoresCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type ConfigurationStoresDeleteFuture 

type ConfigurationStoresDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ConfigurationStoresClient) (autorest.Response, error)
}

ConfigurationStoresDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type ConfigurationStoresUpdateFuture 

type ConfigurationStoresUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ConfigurationStoresClient) (ConfigurationStore, error)
}

ConfigurationStoresUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type Error 

type Error struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message.
	Message *string `json:"message,omitempty"`
}

Error appConfiguration error object.

type KeyValue 

type KeyValue struct {
	autorest.Response `json:"-"`
	// Key - READ-ONLY; The primary identifier of a key-value.
	// The key is used in unison with the label to uniquely identify a key-value.
	Key *string `json:"key,omitempty"`
	// Label - READ-ONLY; A value used to group key-values.
	// The label is used in unison with the key to uniquely identify a key-value.
	Label *string `json:"label,omitempty"`
	// Value - READ-ONLY; The value of the key-value.
	Value *string `json:"value,omitempty"`
	// ContentType - READ-ONLY; The content type of the key-value's value.
	// Providing a proper content-type can enable transformations of values when they are retrieved by applications.
	ContentType *string `json:"contentType,omitempty"`
	// ETag - READ-ONLY; An ETag indicating the state of a key-value within a configuration store.
	ETag *string `json:"eTag,omitempty"`
	// LastModified - READ-ONLY; The last time a modifying operation was performed on the given key-value.
	LastModified *date.Time `json:"lastModified,omitempty"`
	// Locked - READ-ONLY; A value indicating whether the key-value is locked.
	// A locked key-value may not be modified until it is unlocked.
	Locked *bool `json:"locked,omitempty"`
	// Tags - READ-ONLY; A dictionary of tags that can help identify what a key-value may be applicable for.
	Tags map[string]*string `json:"tags"`
}

KeyValue the result of a request to retrieve a key-value from the specified configuration store.

func (KeyValue) MarshalJSON 

func (kv KeyValue) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyValue.

type ListKeyValueParameters 

type ListKeyValueParameters struct {
	// Key - The key to retrieve.
	Key *string `json:"key,omitempty"`
	// Label - The label of the key.
	Label *string `json:"label,omitempty"`
}

ListKeyValueParameters the parameters used to list a configuration store key-value

type NameAvailabilityStatus 

type NameAvailabilityStatus struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; The value indicating whether the resource name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Message - READ-ONLY; If any, the error message that provides more detail for the reason that the name is not available.
	Message *string `json:"message,omitempty"`
	// Reason - READ-ONLY; If any, the reason that the name is not available.
	Reason *string `json:"reason,omitempty"`
}

NameAvailabilityStatus the result of a request to check the availability of a resource name.

type OperationDefinition 

type OperationDefinition struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The display information for the configuration store operation.
	Display *OperationDefinitionDisplay `json:"display,omitempty"`
}

OperationDefinition the definition of a configuration store operation.

type OperationDefinitionDisplay 

type OperationDefinitionDisplay struct {
	// Provider - READ-ONLY; The resource provider name: Microsoft App Configuration."
	Provider *string `json:"provider,omitempty"`
	// Resource - The resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - The operation that users can perform.
	Operation *string `json:"operation,omitempty"`
	// Description - The description for the operation.
	Description *string `json:"description,omitempty"`
}

OperationDefinitionDisplay the display information for a configuration store operation.

func (OperationDefinitionDisplay) MarshalJSON 

func (odd OperationDefinitionDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDefinitionDisplay.

type OperationDefinitionListResult 

type OperationDefinitionListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection value.
	Value *[]OperationDefinition `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationDefinitionListResult the result of a request to list configuration store operations.

func (OperationDefinitionListResult) IsEmpty 

func (odlr OperationDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationDefinitionListResultIterator 

type OperationDefinitionListResultIterator struct {
	// contains filtered or unexported fields
}

OperationDefinitionListResultIterator provides access to a complete listing of OperationDefinition values.

func NewOperationDefinitionListResultIterator 

func NewOperationDefinitionListResultIterator(page OperationDefinitionListResultPage) OperationDefinitionListResultIterator

Creates a new instance of the OperationDefinitionListResultIterator type.

func (*OperationDefinitionListResultIterator) Next 

func (iter *OperationDefinitionListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationDefinitionListResultIterator) NextWithContext 

func (iter *OperationDefinitionListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationDefinitionListResultIterator) NotDone 

func (iter OperationDefinitionListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationDefinitionListResultIterator) Response 

func (iter OperationDefinitionListResultIterator) Response() OperationDefinitionListResult

Response returns the raw server response from the last page request.

func (OperationDefinitionListResultIterator) Value 

func (iter OperationDefinitionListResultIterator) Value() OperationDefinition

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationDefinitionListResultPage 

type OperationDefinitionListResultPage struct {
	// contains filtered or unexported fields
}

OperationDefinitionListResultPage contains a page of OperationDefinition values.

func NewOperationDefinitionListResultPage 

func NewOperationDefinitionListResultPage(cur OperationDefinitionListResult, getNextPage func(context.Context, OperationDefinitionListResult) (OperationDefinitionListResult, error)) OperationDefinitionListResultPage

Creates a new instance of the OperationDefinitionListResultPage type.

func (*OperationDefinitionListResultPage) Next 

func (page *OperationDefinitionListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationDefinitionListResultPage) NextWithContext 

func (page *OperationDefinitionListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationDefinitionListResultPage) NotDone 

func (page OperationDefinitionListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationDefinitionListResultPage) Response 

func (page OperationDefinitionListResultPage) Response() OperationDefinitionListResult

Response returns the raw server response from the last page request.

func (OperationDefinitionListResultPage) Values 

func (page OperationDefinitionListResultPage) Values() []OperationDefinition

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Appconfiguration service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) CheckNameAvailability 

func (client OperationsClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityParameters CheckNameAvailabilityParameters) (result NameAvailabilityStatus, err error)

CheckNameAvailability checks whether the configuration store name is available for use. Parameters: checkNameAvailabilityParameters - the object containing information for the availability request.

func (OperationsClient) CheckNameAvailabilityPreparer 

func (client OperationsClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityParameters CheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (OperationsClient) CheckNameAvailabilityResponder 

func (client OperationsClient) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityStatus, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (OperationsClient) CheckNameAvailabilitySender 

func (client OperationsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context, skipToken string) (result OperationDefinitionListResultPage, err error)

List lists the operations available from this provider. Parameters: skipToken - a skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context, skipToken string) (result OperationDefinitionListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationDefinitionListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
	// Updating ...
	Updating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	// ID - The id of the key to regenerate.
	ID *string `json:"id,omitempty"`
}

RegenerateKeyParameters the parameters used to regenerate an API key.

type Resource 

type Resource struct {
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource. This cannot be changed after the resource is created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

Resource an Azure resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

Source Files

View all Source files

Directories

Path Synopsis

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.