generated

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AzureAppConfigurationClient 

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

AzureAppConfigurationClient contains the methods for the AzureAppConfiguration group. Don't use this type directly, use a constructor function instead.

func NewAzureAppConfigurationClient 

func NewAzureAppConfigurationClient(endpoint string, client *azcore.Client) *AzureAppConfigurationClient

func (*AzureAppConfigurationClient) BeginCreateSnapshot added in v1.1.0 

func (client *AzureAppConfigurationClient) BeginCreateSnapshot(ctx context.Context, name string, entity Snapshot, options *AzureAppConfigurationClientBeginCreateSnapshotOptions) (*runtime.Poller[AzureAppConfigurationClientCreateSnapshotResponse], error)

BeginCreateSnapshot - Creates a key-value snapshot. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • name - The name of the key-value snapshot to create.
  • entity - The key-value snapshot to create.
  • options - AzureAppConfigurationClientBeginCreateSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.BeginCreateSnapshot method.

func (*AzureAppConfigurationClient) CheckKeyValue 

func (client *AzureAppConfigurationClient) CheckKeyValue(ctx context.Context, key string, options *AzureAppConfigurationClientCheckKeyValueOptions) (AzureAppConfigurationClientCheckKeyValueResponse, error)

CheckKeyValue - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to retrieve.
  • options - AzureAppConfigurationClientCheckKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeyValue method.

func (*AzureAppConfigurationClient) CheckKeyValues 

func (client *AzureAppConfigurationClient) CheckKeyValues(ctx context.Context, options *AzureAppConfigurationClientCheckKeyValuesOptions) (AzureAppConfigurationClientCheckKeyValuesResponse, error)

CheckKeyValues - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientCheckKeyValuesOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeyValues method.

func (*AzureAppConfigurationClient) CheckKeys 

func (client *AzureAppConfigurationClient) CheckKeys(ctx context.Context, options *AzureAppConfigurationClientCheckKeysOptions) (AzureAppConfigurationClientCheckKeysResponse, error)

CheckKeys - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientCheckKeysOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeys method.

func (*AzureAppConfigurationClient) CheckLabels 

func (client *AzureAppConfigurationClient) CheckLabels(ctx context.Context, options *AzureAppConfigurationClientCheckLabelsOptions) (AzureAppConfigurationClientCheckLabelsResponse, error)

CheckLabels - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientCheckLabelsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckLabels method.

func (*AzureAppConfigurationClient) CheckRevisions 

func (client *AzureAppConfigurationClient) CheckRevisions(ctx context.Context, options *AzureAppConfigurationClientCheckRevisionsOptions) (AzureAppConfigurationClientCheckRevisionsResponse, error)

CheckRevisions - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientCheckRevisionsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckRevisions method.

func (*AzureAppConfigurationClient) CheckSnapshot added in v1.1.0 

func (client *AzureAppConfigurationClient) CheckSnapshot(ctx context.Context, name string, options *AzureAppConfigurationClientCheckSnapshotOptions) (AzureAppConfigurationClientCheckSnapshotResponse, error)

CheckSnapshot - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • name - The name of the key-value snapshot to check.
  • options - AzureAppConfigurationClientCheckSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.CheckSnapshot method.

func (*AzureAppConfigurationClient) CheckSnapshots added in v1.1.0 

func (client *AzureAppConfigurationClient) CheckSnapshots(ctx context.Context, options *AzureAppConfigurationClientCheckSnapshotsOptions) (AzureAppConfigurationClientCheckSnapshotsResponse, error)

CheckSnapshots - Requests the headers and status of the given resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientCheckSnapshotsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckSnapshots method.

func (*AzureAppConfigurationClient) CreateSnapshot added in v1.1.0 

func (client *AzureAppConfigurationClient) CreateSnapshot(ctx context.Context, name string, entity Snapshot, options *AzureAppConfigurationClientBeginCreateSnapshotOptions) (*http.Response, error)

CreateSnapshot - Creates a key-value snapshot. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

func (*AzureAppConfigurationClient) DeleteKeyValue 

func (client *AzureAppConfigurationClient) DeleteKeyValue(ctx context.Context, key string, options *AzureAppConfigurationClientDeleteKeyValueOptions) (AzureAppConfigurationClientDeleteKeyValueResponse, error)

DeleteKeyValue - Deletes a key-value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to delete.
  • options - AzureAppConfigurationClientDeleteKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.DeleteKeyValue method.

func (*AzureAppConfigurationClient) DeleteLock 

func (client *AzureAppConfigurationClient) DeleteLock(ctx context.Context, key string, options *AzureAppConfigurationClientDeleteLockOptions) (AzureAppConfigurationClientDeleteLockResponse, error)

DeleteLock - Unlocks a key-value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to unlock.
  • options - AzureAppConfigurationClientDeleteLockOptions contains the optional parameters for the AzureAppConfigurationClient.DeleteLock method.

func (*AzureAppConfigurationClient) GetKeyValue 

func (client *AzureAppConfigurationClient) GetKeyValue(ctx context.Context, key string, options *AzureAppConfigurationClientGetKeyValueOptions) (AzureAppConfigurationClientGetKeyValueResponse, error)

GetKeyValue - Gets a single key-value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to retrieve.
  • options - AzureAppConfigurationClientGetKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.GetKeyValue method.

func (*AzureAppConfigurationClient) GetOperationDetails added in v1.1.0 

func (client *AzureAppConfigurationClient) GetOperationDetails(ctx context.Context, snapshot string, options *AzureAppConfigurationClientGetOperationDetailsOptions) (AzureAppConfigurationClientGetOperationDetailsResponse, error)

GetOperationDetails - Gets the state of a long running operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • snapshot - Snapshot identifier for the long running operation.
  • options - AzureAppConfigurationClientGetOperationDetailsOptions contains the optional parameters for the AzureAppConfigurationClient.GetOperationDetails method.

func (*AzureAppConfigurationClient) GetSnapshot added in v1.1.0 

func (client *AzureAppConfigurationClient) GetSnapshot(ctx context.Context, name string, options *AzureAppConfigurationClientGetSnapshotOptions) (AzureAppConfigurationClientGetSnapshotResponse, error)

GetSnapshot - Gets a single key-value snapshot. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • name - The name of the key-value snapshot to retrieve.
  • options - AzureAppConfigurationClientGetSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.GetSnapshot method.

func (*AzureAppConfigurationClient) NewGetKeyValuesPager 

func (client *AzureAppConfigurationClient) NewGetKeyValuesPager(options *AzureAppConfigurationClientGetKeyValuesOptions) *runtime.Pager[AzureAppConfigurationClientGetKeyValuesResponse]

NewGetKeyValuesPager - Gets a list of key-values.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientGetKeyValuesOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetKeyValuesPager method.

func (*AzureAppConfigurationClient) NewGetKeysPager 

func (client *AzureAppConfigurationClient) NewGetKeysPager(options *AzureAppConfigurationClientGetKeysOptions) *runtime.Pager[AzureAppConfigurationClientGetKeysResponse]

NewGetKeysPager - Gets a list of keys.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientGetKeysOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetKeysPager method.

func (*AzureAppConfigurationClient) NewGetLabelsPager 

func (client *AzureAppConfigurationClient) NewGetLabelsPager(options *AzureAppConfigurationClientGetLabelsOptions) *runtime.Pager[AzureAppConfigurationClientGetLabelsResponse]

NewGetLabelsPager - Gets a list of labels.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientGetLabelsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetLabelsPager method.

func (*AzureAppConfigurationClient) NewGetRevisionsPager 

func (client *AzureAppConfigurationClient) NewGetRevisionsPager(options *AzureAppConfigurationClientGetRevisionsOptions) *runtime.Pager[AzureAppConfigurationClientGetRevisionsResponse]

NewGetRevisionsPager - Gets a list of key-value revisions.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientGetRevisionsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetRevisionsPager method.

func (*AzureAppConfigurationClient) NewGetSnapshotsPager added in v1.1.0 

func (client *AzureAppConfigurationClient) NewGetSnapshotsPager(options *AzureAppConfigurationClientGetSnapshotsOptions) *runtime.Pager[AzureAppConfigurationClientGetSnapshotsResponse]

NewGetSnapshotsPager - Gets a list of key-value snapshots.

Generated from API version 2023-10-01

  • options - AzureAppConfigurationClientGetSnapshotsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetSnapshotsPager method.

func (*AzureAppConfigurationClient) Pipeline added in v1.1.0 

func (a *AzureAppConfigurationClient) Pipeline() runtime.Pipeline

func (*AzureAppConfigurationClient) PutKeyValue 

func (client *AzureAppConfigurationClient) PutKeyValue(ctx context.Context, key string, entity KeyValue, options *AzureAppConfigurationClientPutKeyValueOptions) (AzureAppConfigurationClientPutKeyValueResponse, error)

PutKeyValue - Creates a key-value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to create.
  • entity - The key-value to create.
  • options - AzureAppConfigurationClientPutKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.PutKeyValue method.

func (*AzureAppConfigurationClient) PutLock 

func (client *AzureAppConfigurationClient) PutLock(ctx context.Context, key string, options *AzureAppConfigurationClientPutLockOptions) (AzureAppConfigurationClientPutLockResponse, error)

PutLock - Locks a key-value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • key - The key of the key-value to lock.
  • options - AzureAppConfigurationClientPutLockOptions contains the optional parameters for the AzureAppConfigurationClient.PutLock method.

func (*AzureAppConfigurationClient) Tracer added in v1.1.0 

func (a *AzureAppConfigurationClient) Tracer() tracing.Tracer

func (*AzureAppConfigurationClient) UpdateSnapshot added in v1.1.0 

func (client *AzureAppConfigurationClient) UpdateSnapshot(ctx context.Context, name string, entity SnapshotUpdateParameters, options *AzureAppConfigurationClientUpdateSnapshotOptions) (AzureAppConfigurationClientUpdateSnapshotResponse, error)

UpdateSnapshot - Updates the state of a key-value snapshot. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01

  • name - The name of the key-value snapshot to update.
  • entity - The parameters used to update the snapshot.
  • options - AzureAppConfigurationClientUpdateSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.UpdateSnapshot method.

type AzureAppConfigurationClientBeginCreateSnapshotOptions added in v1.1.0 

type AzureAppConfigurationClientBeginCreateSnapshotOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureAppConfigurationClientBeginCreateSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.BeginCreateSnapshot method.

type AzureAppConfigurationClientCheckKeyValueOptions 

type AzureAppConfigurationClientCheckKeyValueOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// The label of the key-value to retrieve.
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields
}

AzureAppConfigurationClientCheckKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeyValue method.

type AzureAppConfigurationClientCheckKeyValueResponse 

type AzureAppConfigurationClientCheckKeyValueResponse struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckKeyValueResponse contains the response from method AzureAppConfigurationClient.CheckKeyValue.

type AzureAppConfigurationClientCheckKeyValuesOptions 

type AzureAppConfigurationClientCheckKeyValuesOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// A filter used to match keys.
	Key *string

	// A filter used to match labels
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields

	// A filter used get key-values for a snapshot. Not valid when used with 'key' and 'label' filters.
	Snapshot *string
}

AzureAppConfigurationClientCheckKeyValuesOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeyValues method.

type AzureAppConfigurationClientCheckKeyValuesResponse 

type AzureAppConfigurationClientCheckKeyValuesResponse struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckKeyValuesResponse contains the response from method AzureAppConfigurationClient.CheckKeyValues.

type AzureAppConfigurationClientCheckKeysOptions 

type AzureAppConfigurationClientCheckKeysOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter for the name of the returned keys.
	Name *string
}

AzureAppConfigurationClientCheckKeysOptions contains the optional parameters for the AzureAppConfigurationClient.CheckKeys method.

type AzureAppConfigurationClientCheckKeysResponse 

type AzureAppConfigurationClientCheckKeysResponse struct {
	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckKeysResponse contains the response from method AzureAppConfigurationClient.CheckKeys.

type AzureAppConfigurationClientCheckLabelsOptions 

type AzureAppConfigurationClientCheckLabelsOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter for the name of the returned labels.
	Name *string

	// Used to select what fields are present in the returned resource(s).
	Select []LabelFields
}

AzureAppConfigurationClientCheckLabelsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckLabels method.

type AzureAppConfigurationClientCheckLabelsResponse 

type AzureAppConfigurationClientCheckLabelsResponse struct {
	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckLabelsResponse contains the response from method AzureAppConfigurationClient.CheckLabels.

type AzureAppConfigurationClientCheckRevisionsOptions 

type AzureAppConfigurationClientCheckRevisionsOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter used to match keys.
	Key *string

	// A filter used to match labels
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields
}

AzureAppConfigurationClientCheckRevisionsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckRevisions method.

type AzureAppConfigurationClientCheckRevisionsResponse 

type AzureAppConfigurationClientCheckRevisionsResponse struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckRevisionsResponse contains the response from method AzureAppConfigurationClient.CheckRevisions.

type AzureAppConfigurationClientCheckSnapshotOptions added in v1.1.0 

type AzureAppConfigurationClientCheckSnapshotOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string
}

AzureAppConfigurationClientCheckSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.CheckSnapshot method.

type AzureAppConfigurationClientCheckSnapshotResponse added in v1.1.0 

type AzureAppConfigurationClientCheckSnapshotResponse struct {
	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Link contains the information returned from the Link header response.
	Link *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckSnapshotResponse contains the response from method AzureAppConfigurationClient.CheckSnapshot.

type AzureAppConfigurationClientCheckSnapshotsOptions added in v1.1.0 

type AzureAppConfigurationClientCheckSnapshotsOptions struct {
	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string
}

AzureAppConfigurationClientCheckSnapshotsOptions contains the optional parameters for the AzureAppConfigurationClient.CheckSnapshots method.

type AzureAppConfigurationClientCheckSnapshotsResponse added in v1.1.0 

type AzureAppConfigurationClientCheckSnapshotsResponse struct {
	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientCheckSnapshotsResponse contains the response from method AzureAppConfigurationClient.CheckSnapshots.

type AzureAppConfigurationClientCreateSnapshotResponse added in v1.1.0 

type AzureAppConfigurationClientCreateSnapshotResponse struct {
	Snapshot
}

AzureAppConfigurationClientCreateSnapshotResponse contains the response from method AzureAppConfigurationClient.BeginCreateSnapshot.

type AzureAppConfigurationClientDeleteKeyValueOptions 

type AzureAppConfigurationClientDeleteKeyValueOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// The label of the key-value to delete.
	Label *string
}

AzureAppConfigurationClientDeleteKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.DeleteKeyValue method.

type AzureAppConfigurationClientDeleteKeyValueResponse 

type AzureAppConfigurationClientDeleteKeyValueResponse struct {
	KeyValue

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientDeleteKeyValueResponse contains the response from method AzureAppConfigurationClient.DeleteKeyValue.

type AzureAppConfigurationClientDeleteLockOptions 

type AzureAppConfigurationClientDeleteLockOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// The label, if any, of the key-value to unlock.
	Label *string
}

AzureAppConfigurationClientDeleteLockOptions contains the optional parameters for the AzureAppConfigurationClient.DeleteLock method.

type AzureAppConfigurationClientDeleteLockResponse 

type AzureAppConfigurationClientDeleteLockResponse struct {
	KeyValue

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientDeleteLockResponse contains the response from method AzureAppConfigurationClient.DeleteLock.

type AzureAppConfigurationClientGetKeyValueOptions 

type AzureAppConfigurationClientGetKeyValueOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// The label of the key-value to retrieve.
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields
}

AzureAppConfigurationClientGetKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.GetKeyValue method.

type AzureAppConfigurationClientGetKeyValueResponse 

type AzureAppConfigurationClientGetKeyValueResponse struct {
	KeyValue

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetKeyValueResponse contains the response from method AzureAppConfigurationClient.GetKeyValue.

type AzureAppConfigurationClientGetKeyValuesOptions 

type AzureAppConfigurationClientGetKeyValuesOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// A filter used to match keys.
	Key *string

	// A filter used to match labels
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields

	// A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key'
	// and 'label' filters.
	Snapshot *string
}

AzureAppConfigurationClientGetKeyValuesOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetKeyValuesPager method.

type AzureAppConfigurationClientGetKeyValuesResponse 

type AzureAppConfigurationClientGetKeyValuesResponse struct {
	// The result of a list request.
	KeyValueListResult

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetKeyValuesResponse contains the response from method AzureAppConfigurationClient.NewGetKeyValuesPager.

type AzureAppConfigurationClientGetKeysOptions 

type AzureAppConfigurationClientGetKeysOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter for the name of the returned keys.
	Name *string
}

AzureAppConfigurationClientGetKeysOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetKeysPager method.

type AzureAppConfigurationClientGetKeysResponse 

type AzureAppConfigurationClientGetKeysResponse struct {
	// The result of a list request.
	KeyListResult

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetKeysResponse contains the response from method AzureAppConfigurationClient.NewGetKeysPager.

type AzureAppConfigurationClientGetLabelsOptions 

type AzureAppConfigurationClientGetLabelsOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter for the name of the returned labels.
	Name *string

	// Used to select what fields are present in the returned resource(s).
	Select []LabelFields
}

AzureAppConfigurationClientGetLabelsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetLabelsPager method.

type AzureAppConfigurationClientGetLabelsResponse 

type AzureAppConfigurationClientGetLabelsResponse struct {
	// The result of a list request.
	LabelListResult

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetLabelsResponse contains the response from method AzureAppConfigurationClient.NewGetLabelsPager.

type AzureAppConfigurationClientGetOperationDetailsOptions added in v1.1.0 

type AzureAppConfigurationClientGetOperationDetailsOptions struct {
}

AzureAppConfigurationClientGetOperationDetailsOptions contains the optional parameters for the AzureAppConfigurationClient.GetOperationDetails method.

type AzureAppConfigurationClientGetOperationDetailsResponse added in v1.1.0 

type AzureAppConfigurationClientGetOperationDetailsResponse struct {
	// Details of a long running operation.
	OperationDetails
}

AzureAppConfigurationClientGetOperationDetailsResponse contains the response from method AzureAppConfigurationClient.GetOperationDetails.

type AzureAppConfigurationClientGetRevisionsOptions 

type AzureAppConfigurationClientGetRevisionsOptions struct {
	// Requests the server to respond with the state of the resource at the specified time.
	AcceptDatetime *string

	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter used to match keys.
	Key *string

	// A filter used to match labels
	Label *string

	// Used to select what fields are present in the returned resource(s).
	Select []SettingFields
}

AzureAppConfigurationClientGetRevisionsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetRevisionsPager method.

type AzureAppConfigurationClientGetRevisionsResponse 

type AzureAppConfigurationClientGetRevisionsResponse struct {
	// The result of a list request.
	KeyValueListResult

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetRevisionsResponse contains the response from method AzureAppConfigurationClient.NewGetRevisionsPager.

type AzureAppConfigurationClientGetSnapshotOptions added in v1.1.0 

type AzureAppConfigurationClientGetSnapshotOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// Used to select what fields are present in the returned resource(s).
	Select []SnapshotFields
}

AzureAppConfigurationClientGetSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.GetSnapshot method.

type AzureAppConfigurationClientGetSnapshotResponse added in v1.1.0 

type AzureAppConfigurationClientGetSnapshotResponse struct {
	Snapshot

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Link contains the information returned from the Link header response.
	Link *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetSnapshotResponse contains the response from method AzureAppConfigurationClient.GetSnapshot.

type AzureAppConfigurationClientGetSnapshotsOptions added in v1.1.0 

type AzureAppConfigurationClientGetSnapshotsOptions struct {
	// Instructs the server to return elements that appear after the element referred to by the specified token.
	After *string

	// A filter for the name of the returned snapshots.
	Name *string

	// Used to select what fields are present in the returned resource(s).
	Select []SnapshotFields

	// Used to filter returned snapshots by their status property.
	Status []SnapshotStatus
}

AzureAppConfigurationClientGetSnapshotsOptions contains the optional parameters for the AzureAppConfigurationClient.NewGetSnapshotsPager method.

type AzureAppConfigurationClientGetSnapshotsResponse added in v1.1.0 

type AzureAppConfigurationClientGetSnapshotsResponse struct {
	// The result of a snapshot list request.
	SnapshotListResult

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientGetSnapshotsResponse contains the response from method AzureAppConfigurationClient.NewGetSnapshotsPager.

type AzureAppConfigurationClientPutKeyValueOptions 

type AzureAppConfigurationClientPutKeyValueOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// The label of the key-value to create.
	Label *string
}

AzureAppConfigurationClientPutKeyValueOptions contains the optional parameters for the AzureAppConfigurationClient.PutKeyValue method.

type AzureAppConfigurationClientPutKeyValueResponse 

type AzureAppConfigurationClientPutKeyValueResponse struct {
	KeyValue

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientPutKeyValueResponse contains the response from method AzureAppConfigurationClient.PutKeyValue.

type AzureAppConfigurationClientPutLockOptions 

type AzureAppConfigurationClientPutLockOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string

	// The label, if any, of the key-value to lock.
	Label *string
}

AzureAppConfigurationClientPutLockOptions contains the optional parameters for the AzureAppConfigurationClient.PutLock method.

type AzureAppConfigurationClientPutLockResponse 

type AzureAppConfigurationClientPutLockResponse struct {
	KeyValue

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientPutLockResponse contains the response from method AzureAppConfigurationClient.PutLock.

type AzureAppConfigurationClientUpdateSnapshotOptions added in v1.1.0 

type AzureAppConfigurationClientUpdateSnapshotOptions struct {
	// Used to perform an operation only if the targeted resource's etag matches the value provided.
	IfMatch *string

	// Used to perform an operation only if the targeted resource's etag does not match the value provided.
	IfNoneMatch *string
}

AzureAppConfigurationClientUpdateSnapshotOptions contains the optional parameters for the AzureAppConfigurationClient.UpdateSnapshot method.

type AzureAppConfigurationClientUpdateSnapshotResponse added in v1.1.0 

type AzureAppConfigurationClientUpdateSnapshotResponse struct {
	Snapshot

	// ETag contains the information returned from the ETag header response.
	ETag *string

	// Link contains the information returned from the Link header response.
	Link *string

	// SyncToken contains the information returned from the Sync-Token header response.
	SyncToken *string
}

AzureAppConfigurationClientUpdateSnapshotResponse contains the response from method AzureAppConfigurationClient.UpdateSnapshot.

type CompositionType added in v1.1.0 

type CompositionType string

CompositionType - The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. 

const (
	CompositionTypeKey      CompositionType = "key"
	CompositionTypeKeyLabel CompositionType = "key_label"
)

func PossibleCompositionTypeValues added in v1.1.0 

func PossibleCompositionTypeValues() []CompositionType

PossibleCompositionTypeValues returns the possible values for the CompositionType const type.

type Error 

type Error struct {
	// A detailed description of the error.
	Detail *string

	// The name of the parameter that resulted in the error.
	Name *string

	// The HTTP status code that the error maps to.
	Status *int32

	// A brief summary of the error.
	Title *string

	// The type of the error.
	Type *string
}

Error - Azure App Configuration error object.

func (Error) MarshalJSON added in v0.4.3 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON added in v0.4.3 

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ErrorDetail added in v1.1.0 

type ErrorDetail struct {
	// REQUIRED; One of a server-defined set of error codes.
	Code *string

	// REQUIRED; A human-readable representation of the error.
	Message *string

	// An array of details about specific errors that led to this reported error.
	Details []ErrorDetail

	// An object containing more specific information than the current object about the error.
	Innererror *InnerError
}

ErrorDetail - The details of an error.

func (ErrorDetail) MarshalJSON added in v1.1.0 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v1.1.0 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type InnerError added in v1.1.0 

type InnerError struct {
	// One of a server-defined set of error codes.
	Code *string

	// An object containing more specific information than the current object about the error.
	Innererror *InnerError
}

InnerError - An object containing specific information about an error.

func (InnerError) MarshalJSON added in v1.1.0 

func (i InnerError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InnerError.

func (*InnerError) UnmarshalJSON added in v1.1.0 

func (i *InnerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InnerError.

type Key 

type Key struct {
	// READ-ONLY; The name of the key.
	Name *string
}

func (Key) MarshalJSON added in v0.4.3 

func (k Key) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Key.

func (*Key) UnmarshalJSON added in v0.4.3 

func (k *Key) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Key.

type KeyListResult 

type KeyListResult struct {
	// The collection value.
	Items []Key

	// The URI that can be used to request the next set of paged results.
	NextLink *string
}

KeyListResult - The result of a list request.

func (KeyListResult) MarshalJSON 

func (k KeyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyListResult.

func (*KeyListResult) UnmarshalJSON added in v0.4.3 

func (k *KeyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyListResult.

type KeyValue 

type KeyValue struct {
	// The content type of the value stored within the key-value.
	ContentType *string

	// A value representing the current state of the resource.
	Etag *string

	// The key of the key-value.
	Key *string

	// The label the key-value belongs to.
	Label *string

	// A date representing the last time the key-value was modified.
	LastModified *time.Time

	// Indicates whether the key-value is locked.
	Locked *bool

	// The tags of the key-value
	Tags map[string]*string

	// The value of the key-value.
	Value *string
}

func (KeyValue) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KeyValue.

func (*KeyValue) UnmarshalJSON 

func (k *KeyValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyValue.

type KeyValueFilter added in v1.1.0 

type KeyValueFilter struct {
	// REQUIRED; Filters key-values by their key field.
	Key *string

	// Filters key-values by their label field.
	Label *string
}

KeyValueFilter - Enables filtering of key-values.

func (KeyValueFilter) MarshalJSON added in v1.1.0 

func (k KeyValueFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyValueFilter.

func (*KeyValueFilter) UnmarshalJSON added in v1.1.0 

func (k *KeyValueFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyValueFilter.

type KeyValueListResult 

type KeyValueListResult struct {
	// An identifier representing the returned state of the resource.
	Etag *string

	// The collection value.
	Items []KeyValue

	// The URI that can be used to request the next set of paged results.
	NextLink *string
}

KeyValueListResult - The result of a list request.

func (KeyValueListResult) MarshalJSON 

func (k KeyValueListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyValueListResult.

func (*KeyValueListResult) UnmarshalJSON added in v0.4.3 

func (k *KeyValueListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyValueListResult.

type Label 

type Label struct {
	// READ-ONLY; The name of the label.
	Name *string
}

func (Label) MarshalJSON added in v0.4.3 

func (l Label) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Label.

func (*Label) UnmarshalJSON added in v0.4.3 

func (l *Label) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Label.

type LabelFields added in v0.4.3 

type LabelFields string
const (
	LabelFieldsName LabelFields = "name"
)

func PossibleLabelFieldsValues added in v0.4.3 

func PossibleLabelFieldsValues() []LabelFields

PossibleLabelFieldsValues returns the possible values for the LabelFields const type.

type LabelListResult 

type LabelListResult struct {
	// The collection value.
	Items []Label

	// The URI that can be used to request the next set of paged results.
	NextLink *string
}

LabelListResult - The result of a list request.

func (LabelListResult) MarshalJSON 

func (l LabelListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LabelListResult.

func (*LabelListResult) UnmarshalJSON added in v0.4.3 

func (l *LabelListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LabelListResult.

type OperationDetails added in v1.1.0 

type OperationDetails struct {
	// REQUIRED; The unique id of the operation.
	ID *string

	// REQUIRED; The current status of the operation
	Status *State

	// An error, available when the status is Failed, describing why the operation failed.
	Error *ErrorDetail
}

OperationDetails - Details of a long running operation.

func (OperationDetails) MarshalJSON added in v1.1.0 

func (o OperationDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDetails.

func (*OperationDetails) UnmarshalJSON added in v1.1.0 

func (o *OperationDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDetails.

type SettingFields added in v0.4.3 

type SettingFields string
const (
	SettingFieldsContentType  SettingFields = "content_type"
	SettingFieldsEtag         SettingFields = "etag"
	SettingFieldsKey          SettingFields = "key"
	SettingFieldsLabel        SettingFields = "label"
	SettingFieldsLastModified SettingFields = "last_modified"
	SettingFieldsLocked       SettingFields = "locked"
	SettingFieldsTags         SettingFields = "tags"
	SettingFieldsValue        SettingFields = "value"
)

func PossibleSettingFieldsValues added in v0.4.3 

func PossibleSettingFieldsValues() []SettingFields

PossibleSettingFieldsValues returns the possible values for the SettingFields const type.

type Snapshot added in v1.1.0 

type Snapshot struct {
	// REQUIRED; A list of filters used to filter the key-values included in the snapshot.
	Filters []KeyValueFilter

	// The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures
	// there are no two key-values containing the same key. The 'key_label' composition
	// type ensures there are no two key-values containing the same key and label.
	CompositionType *CompositionType

	// The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only
	// writable during the creation of a snapshot. If not specified, the default
	// lifetime of key-value revisions will be used.
	RetentionPeriod *int64

	// The tags of the snapshot.
	Tags map[string]*string

	// READ-ONLY; The time that the snapshot was created.
	Created *time.Time

	// READ-ONLY; A value representing the current state of the snapshot.
	Etag *string

	// READ-ONLY; The time that the snapshot will expire.
	Expires *time.Time

	// READ-ONLY; The amount of key-values in the snapshot.
	ItemsCount *int64

	// READ-ONLY; The name of the snapshot.
	Name *string

	// READ-ONLY; The size in bytes of the snapshot.
	Size *int64

	// READ-ONLY; The current status of the snapshot.
	Status *SnapshotStatus
}

func (Snapshot) MarshalJSON added in v1.1.0 

func (s Snapshot) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Snapshot.

func (*Snapshot) UnmarshalJSON added in v1.1.0 

func (s *Snapshot) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Snapshot.

type SnapshotFields added in v1.1.0 

type SnapshotFields string
const (
	SnapshotFieldsCompositionType SnapshotFields = "composition_type"
	SnapshotFieldsCreated         SnapshotFields = "created"
	SnapshotFieldsETag            SnapshotFields = "etag"
	SnapshotFieldsExpires         SnapshotFields = "expires"
	SnapshotFieldsFilters         SnapshotFields = "filters"
	SnapshotFieldsItemsCount      SnapshotFields = "items_count"
	SnapshotFieldsName            SnapshotFields = "name"
	SnapshotFieldsRetentionPeriod SnapshotFields = "retention_period"
	SnapshotFieldsSize            SnapshotFields = "size"
	SnapshotFieldsStatus          SnapshotFields = "status"
	SnapshotFieldsTags            SnapshotFields = "tags"
)

func PossibleSnapshotFieldsValues added in v1.1.0 

func PossibleSnapshotFieldsValues() []SnapshotFields

PossibleSnapshotFieldsValues returns the possible values for the SnapshotFields const type.

type SnapshotListResult added in v1.1.0 

type SnapshotListResult struct {
	// The collection value.
	Items []Snapshot

	// The URI that can be used to request the next set of paged results.
	NextLink *string
}

SnapshotListResult - The result of a snapshot list request.

func (SnapshotListResult) MarshalJSON added in v1.1.0 

func (s SnapshotListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SnapshotListResult.

func (*SnapshotListResult) UnmarshalJSON added in v1.1.0 

func (s *SnapshotListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotListResult.

type SnapshotStatus added in v1.1.0 

type SnapshotStatus string

SnapshotStatus - The current status of the snapshot. 

const (
	SnapshotStatusArchived     SnapshotStatus = "archived"
	SnapshotStatusFailed       SnapshotStatus = "failed"
	SnapshotStatusProvisioning SnapshotStatus = "provisioning"
	SnapshotStatusReady        SnapshotStatus = "ready"
)

func PossibleSnapshotStatusValues added in v1.1.0 

func PossibleSnapshotStatusValues() []SnapshotStatus

PossibleSnapshotStatusValues returns the possible values for the SnapshotStatus const type.

type SnapshotUpdateParameters added in v1.1.0 

type SnapshotUpdateParameters struct {
	// The desired status of the snapshot.
	Status *SnapshotStatus
}

SnapshotUpdateParameters - Parameters used to update a snapshot.

func (SnapshotUpdateParameters) MarshalJSON added in v1.1.0 

func (s SnapshotUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SnapshotUpdateParameters.

func (*SnapshotUpdateParameters) UnmarshalJSON added in v1.1.0 

func (s *SnapshotUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotUpdateParameters.

type State added in v1.1.0 

type State string

State - The current status of the operation 

const (
	StateCanceled   State = "Canceled"
	StateFailed     State = "Failed"
	StateNotStarted State = "NotStarted"
	StateRunning    State = "Running"
	StateSucceeded  State = "Succeeded"
)

func PossibleStateValues added in v1.1.0 

func PossibleStateValues() []State

PossibleStateValues returns the possible values for the State const type.

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.