armappconfiguration

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2021 License: MIT Imports: 15 Imported by: 6

README

Azure App Configuration Module for Go

PkgGoDev

The armappconfiguration module provides operations for working with Azure App Configuration.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure App Configuration module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure App Configuration. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure App Configuration modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armappconfiguration.NewPrivateEndpointConnectionsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armappconfiguration.NewPrivateEndpointConnectionsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the App Configuration label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey 

type APIKey struct {
	// READ-ONLY; A connection string that can be used by supporting clients for authentication.
	ConnectionString *string `json:"connectionString,omitempty" azure:"ro"`

	// READ-ONLY; The key ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The last time any of the key's properties were modified.
	LastModified *time.Time `json:"lastModified,omitempty" azure:"ro"`

	// READ-ONLY; A name for the key describing its usage.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Whether this key can only be used for read operations.
	ReadOnly *bool `json:"readOnly,omitempty" azure:"ro"`

	// READ-ONLY; The value of the key that is used for authentication purposes.
	Value *string `json:"value,omitempty" azure:"ro"`
}

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

func (APIKey) MarshalJSON 

func (a APIKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIKey.

func (*APIKey) UnmarshalJSON 

func (a *APIKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIKey.

type APIKeyListResult 

type APIKeyListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*APIKey `json:"value,omitempty"`
}

APIKeyListResult - The result of a request to list API keys.

func (APIKeyListResult) MarshalJSON 

func (a APIKeyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIKeyListResult.

type ActionsRequired 

type ActionsRequired string

ActionsRequired - Any action that is required beyond basic workflow (approve/ reject/ disconnect) 

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

func PossibleActionsRequiredValues 

func PossibleActionsRequiredValues() []ActionsRequired

PossibleActionsRequiredValues returns the possible values for the ActionsRequired const type.

func (ActionsRequired) ToPtr 

func (c ActionsRequired) ToPtr() *ActionsRequired

ToPtr returns a *ActionsRequired pointing to the current value.

type CheckNameAvailabilityParameters 

type CheckNameAvailabilityParameters struct {
	// REQUIRED; The name to check for availability.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The resource type to check for name availability.
	Type *ConfigurationResourceType `json:"type,omitempty"`
}

CheckNameAvailabilityParameters - Parameters used for checking whether a resource name is available.

type ConfigurationResourceType 

type ConfigurationResourceType string

ConfigurationResourceType - The resource type to check for name availability. 

const (
	ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores ConfigurationResourceType = "Microsoft.AppConfiguration/configurationStores"
)

func PossibleConfigurationResourceTypeValues 

func PossibleConfigurationResourceTypeValues() []ConfigurationResourceType

PossibleConfigurationResourceTypeValues returns the possible values for the ConfigurationResourceType const type.

func (ConfigurationResourceType) ToPtr 

func (c ConfigurationResourceType) ToPtr() *ConfigurationResourceType

ToPtr returns a *ConfigurationResourceType pointing to the current value.

type ConfigurationStore 

type ConfigurationStore struct {
	TrackedResource
	// REQUIRED; The sku of the configuration store.
	SKU *SKU `json:"sku,omitempty"`

	// The managed identity information, if configured.
	Identity *ResourceIdentity `json:"identity,omitempty"`

	// The properties of a configuration store.
	Properties *ConfigurationStoreProperties `json:"properties,omitempty"`

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

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

func (ConfigurationStore) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationStore.

type ConfigurationStoreListResult 

type ConfigurationStoreListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*ConfigurationStore `json:"value,omitempty"`
}

ConfigurationStoreListResult - The result of a request to list configuration stores.

func (ConfigurationStoreListResult) MarshalJSON 

func (c ConfigurationStoreListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationStoreListResult.

type ConfigurationStoreProperties 

type ConfigurationStoreProperties struct {
	// Disables all authentication methods other than AAD authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// The encryption settings of the configuration store.
	Encryption *EncryptionProperties `json:"encryption,omitempty"`

	// Control permission for data plane traffic coming from public networks while private endpoint is enabled.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// READ-ONLY; The creation date of configuration store.
	CreationDate *time.Time `json:"creationDate,omitempty" azure:"ro"`

	// READ-ONLY; The DNS endpoint where the configuration store API will be available.
	Endpoint *string `json:"endpoint,omitempty" azure:"ro"`

	// READ-ONLY; The list of private endpoint connections that are set up for this resource.
	PrivateEndpointConnections []*PrivateEndpointConnectionReference `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the configuration store.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ConfigurationStoreProperties - The properties of a configuration store.

func (ConfigurationStoreProperties) MarshalJSON 

func (c ConfigurationStoreProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationStoreProperties.

func (*ConfigurationStoreProperties) UnmarshalJSON 

func (c *ConfigurationStoreProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationStoreProperties.

type ConfigurationStorePropertiesUpdateParameters 

type ConfigurationStorePropertiesUpdateParameters struct {
	// Disables all authentication methods other than AAD authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// The encryption settings of the configuration store.
	Encryption *EncryptionProperties `json:"encryption,omitempty"`

	// Control permission for data plane traffic coming from public networks while private endpoint is enabled.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

ConfigurationStorePropertiesUpdateParameters - The properties for updating a configuration store.

type ConfigurationStoreUpdateParameters 

type ConfigurationStoreUpdateParameters struct {
	// The managed identity information for the configuration store.
	Identity *ResourceIdentity `json:"identity,omitempty"`

	// The properties for updating a configuration store.
	Properties *ConfigurationStorePropertiesUpdateParameters `json:"properties,omitempty"`

	// The SKU of the configuration store.
	SKU *SKU `json:"sku,omitempty"`

	// The ARM resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

ConfigurationStoreUpdateParameters - The parameters for updating a configuration store.

func (ConfigurationStoreUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConfigurationStoreUpdateParameters.

type ConfigurationStoresBeginCreateOptions 

type ConfigurationStoresBeginCreateOptions struct {
}

ConfigurationStoresBeginCreateOptions contains the optional parameters for the ConfigurationStores.BeginCreate method.

type ConfigurationStoresBeginDeleteOptions 

type ConfigurationStoresBeginDeleteOptions struct {
}

ConfigurationStoresBeginDeleteOptions contains the optional parameters for the ConfigurationStores.BeginDelete method.

type ConfigurationStoresBeginUpdateOptions 

type ConfigurationStoresBeginUpdateOptions struct {
}

ConfigurationStoresBeginUpdateOptions contains the optional parameters for the ConfigurationStores.BeginUpdate method.

type ConfigurationStoresClient 

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

ConfigurationStoresClient contains the methods for the ConfigurationStores group. Don't use this type directly, use NewConfigurationStoresClient() instead.

func NewConfigurationStoresClient 

func NewConfigurationStoresClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ConfigurationStoresClient

NewConfigurationStoresClient creates a new instance of ConfigurationStoresClient with the specified values.

func (*ConfigurationStoresClient) BeginCreate 

func (client *ConfigurationStoresClient) BeginCreate(ctx context.Context, resourceGroupName string, configStoreName string, configStoreCreationParameters ConfigurationStore, options *ConfigurationStoresBeginCreateOptions) (ConfigurationStoresCreatePollerResponse, error)

BeginCreate - Creates a configuration store with the specified parameters. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresCreate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		armappconfiguration.ConfigurationStore{
			TrackedResource: armappconfiguration.TrackedResource{
				Location: to.StringPtr("<location>"),
				Tags: map[string]*string{
					"myTag": to.StringPtr("myTagValue"),
				},
			},
			SKU: &armappconfiguration.SKU{
				Name: to.StringPtr("<name>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ConfigurationStore.ID: %s\n", *res.ID)
}

Output:

func (*ConfigurationStoresClient) BeginDelete 

func (client *ConfigurationStoresClient) BeginDelete(ctx context.Context, resourceGroupName string, configStoreName string, options *ConfigurationStoresBeginDeleteOptions) (ConfigurationStoresDeletePollerResponse, error)

BeginDelete - Deletes a configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresDelete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ConfigurationStoresClient) BeginUpdate 

func (client *ConfigurationStoresClient) BeginUpdate(ctx context.Context, resourceGroupName string, configStoreName string, configStoreUpdateParameters ConfigurationStoreUpdateParameters, options *ConfigurationStoresBeginUpdateOptions) (ConfigurationStoresUpdatePollerResponse, error)

BeginUpdate - Updates a configuration store with the specified parameters. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresUpdate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		armappconfiguration.ConfigurationStoreUpdateParameters{
			SKU: &armappconfiguration.SKU{
				Name: to.StringPtr("<name>"),
			},
			Tags: map[string]*string{
				"Category": to.StringPtr("Marketing"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ConfigurationStore.ID: %s\n", *res.ID)
}

Output:

func (*ConfigurationStoresClient) Get 

func (client *ConfigurationStoresClient) Get(ctx context.Context, resourceGroupName string, configStoreName string, options *ConfigurationStoresGetOptions) (ConfigurationStoresGetResponse, error)

Get - Gets the properties of the specified configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ConfigurationStore.ID: %s\n", *res.ID)
}

Output:

func (*ConfigurationStoresClient) List 

func (client *ConfigurationStoresClient) List(options *ConfigurationStoresListOptions) *ConfigurationStoresListPager

List - Lists the configuration stores for a given subscription. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	pager := client.List(&armappconfiguration.ConfigurationStoresListOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("ConfigurationStore.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*ConfigurationStoresClient) ListByResourceGroup 

func (client *ConfigurationStoresClient) ListByResourceGroup(resourceGroupName string, options *ConfigurationStoresListByResourceGroupOptions) *ConfigurationStoresListByResourceGroupPager

ListByResourceGroup - Lists the configuration stores for a given resource group. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		&armappconfiguration.ConfigurationStoresListByResourceGroupOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("ConfigurationStore.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*ConfigurationStoresClient) ListKeys 

func (client *ConfigurationStoresClient) ListKeys(resourceGroupName string, configStoreName string, options *ConfigurationStoresListKeysOptions) *ConfigurationStoresListKeysPager

ListKeys - Lists the access key for the specified configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresListKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	pager := client.ListKeys("<resource-group-name>",
		"<config-store-name>",
		&armappconfiguration.ConfigurationStoresListKeysOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("APIKey.ID: %s\n", *v.ID)
		}
	}
}

Output:

func (*ConfigurationStoresClient) RegenerateKey 

func (client *ConfigurationStoresClient) RegenerateKey(ctx context.Context, resourceGroupName string, configStoreName string, regenerateKeyParameters RegenerateKeyParameters, options *ConfigurationStoresRegenerateKeyOptions) (ConfigurationStoresRegenerateKeyResponse, error)

RegenerateKey - Regenerates an access key for the specified configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresRegenerateKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewConfigurationStoresClient("<subscription-id>", cred, nil)
	res, err := client.RegenerateKey(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		armappconfiguration.RegenerateKeyParameters{
			ID: to.StringPtr("<id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("APIKey.ID: %s\n", *res.ID)
}

Output:

type ConfigurationStoresCreatePoller 

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

ConfigurationStoresCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*ConfigurationStoresCreatePoller) Done 

func (p *ConfigurationStoresCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConfigurationStoresCreatePoller) FinalResponse 

func (p *ConfigurationStoresCreatePoller) FinalResponse(ctx context.Context) (ConfigurationStoresCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConfigurationStoresCreateResponse will be returned.

func (*ConfigurationStoresCreatePoller) Poll 

func (p *ConfigurationStoresCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConfigurationStoresCreatePoller) ResumeToken 

func (p *ConfigurationStoresCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConfigurationStoresCreatePollerResponse 

type ConfigurationStoresCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresCreatePollerResponse contains the response from method ConfigurationStores.Create.

func (ConfigurationStoresCreatePollerResponse) PollUntilDone 

func (l ConfigurationStoresCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConfigurationStoresCreatePollerResponse) Resume 

func (l *ConfigurationStoresCreatePollerResponse) Resume(ctx context.Context, client *ConfigurationStoresClient, token string) error

Resume rehydrates a ConfigurationStoresCreatePollerResponse from the provided client and resume token.

type ConfigurationStoresCreateResponse 

type ConfigurationStoresCreateResponse struct {
	ConfigurationStoresCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresCreateResponse contains the response from method ConfigurationStores.Create.

type ConfigurationStoresCreateResult 

type ConfigurationStoresCreateResult struct {
	ConfigurationStore
}

ConfigurationStoresCreateResult contains the result from method ConfigurationStores.Create.

type ConfigurationStoresDeletePoller 

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

ConfigurationStoresDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ConfigurationStoresDeletePoller) Done 

func (p *ConfigurationStoresDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConfigurationStoresDeletePoller) FinalResponse 

func (p *ConfigurationStoresDeletePoller) FinalResponse(ctx context.Context) (ConfigurationStoresDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConfigurationStoresDeleteResponse will be returned.

func (*ConfigurationStoresDeletePoller) Poll 

func (p *ConfigurationStoresDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConfigurationStoresDeletePoller) ResumeToken 

func (p *ConfigurationStoresDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConfigurationStoresDeletePollerResponse 

type ConfigurationStoresDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresDeletePollerResponse contains the response from method ConfigurationStores.Delete.

func (ConfigurationStoresDeletePollerResponse) PollUntilDone 

func (l ConfigurationStoresDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConfigurationStoresDeletePollerResponse) Resume 

func (l *ConfigurationStoresDeletePollerResponse) Resume(ctx context.Context, client *ConfigurationStoresClient, token string) error

Resume rehydrates a ConfigurationStoresDeletePollerResponse from the provided client and resume token.

type ConfigurationStoresDeleteResponse 

type ConfigurationStoresDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresDeleteResponse contains the response from method ConfigurationStores.Delete.

type ConfigurationStoresGetOptions 

type ConfigurationStoresGetOptions struct {
}

ConfigurationStoresGetOptions contains the optional parameters for the ConfigurationStores.Get method.

type ConfigurationStoresGetResponse 

type ConfigurationStoresGetResponse struct {
	ConfigurationStoresGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresGetResponse contains the response from method ConfigurationStores.Get.

type ConfigurationStoresGetResult 

type ConfigurationStoresGetResult struct {
	ConfigurationStore
}

ConfigurationStoresGetResult contains the result from method ConfigurationStores.Get.

type ConfigurationStoresListByResourceGroupOptions 

type ConfigurationStoresListByResourceGroupOptions struct {
	// 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.
	SkipToken *string
}

ConfigurationStoresListByResourceGroupOptions contains the optional parameters for the ConfigurationStores.ListByResourceGroup method.

type ConfigurationStoresListByResourceGroupPager 

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

ConfigurationStoresListByResourceGroupPager provides operations for iterating over paged responses.

func (*ConfigurationStoresListByResourceGroupPager) Err 

func (p *ConfigurationStoresListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresListByResourceGroupPager) NextPage 

func (p *ConfigurationStoresListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ConfigurationStoresListByResourceGroupPager) PageResponse 

func (p *ConfigurationStoresListByResourceGroupPager) PageResponse() ConfigurationStoresListByResourceGroupResponse

PageResponse returns the current ConfigurationStoresListByResourceGroupResponse page.

type ConfigurationStoresListByResourceGroupResponse 

type ConfigurationStoresListByResourceGroupResponse struct {
	ConfigurationStoresListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresListByResourceGroupResponse contains the response from method ConfigurationStores.ListByResourceGroup.

type ConfigurationStoresListByResourceGroupResult 

type ConfigurationStoresListByResourceGroupResult struct {
	ConfigurationStoreListResult
}

ConfigurationStoresListByResourceGroupResult contains the result from method ConfigurationStores.ListByResourceGroup.

type ConfigurationStoresListKeysOptions 

type ConfigurationStoresListKeysOptions struct {
	// 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.
	SkipToken *string
}

ConfigurationStoresListKeysOptions contains the optional parameters for the ConfigurationStores.ListKeys method.

type ConfigurationStoresListKeysPager 

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

ConfigurationStoresListKeysPager provides operations for iterating over paged responses.

func (*ConfigurationStoresListKeysPager) Err 

func (p *ConfigurationStoresListKeysPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresListKeysPager) NextPage 

func (p *ConfigurationStoresListKeysPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ConfigurationStoresListKeysPager) PageResponse 

func (p *ConfigurationStoresListKeysPager) PageResponse() ConfigurationStoresListKeysResponse

PageResponse returns the current ConfigurationStoresListKeysResponse page.

type ConfigurationStoresListKeysResponse 

type ConfigurationStoresListKeysResponse struct {
	ConfigurationStoresListKeysResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresListKeysResponse contains the response from method ConfigurationStores.ListKeys.

type ConfigurationStoresListKeysResult 

type ConfigurationStoresListKeysResult struct {
	APIKeyListResult
}

ConfigurationStoresListKeysResult contains the result from method ConfigurationStores.ListKeys.

type ConfigurationStoresListOptions 

type ConfigurationStoresListOptions struct {
	// 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.
	SkipToken *string
}

ConfigurationStoresListOptions contains the optional parameters for the ConfigurationStores.List method.

type ConfigurationStoresListPager 

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

ConfigurationStoresListPager provides operations for iterating over paged responses.

func (*ConfigurationStoresListPager) Err 

func (p *ConfigurationStoresListPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresListPager) NextPage 

func (p *ConfigurationStoresListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ConfigurationStoresListPager) PageResponse 

func (p *ConfigurationStoresListPager) PageResponse() ConfigurationStoresListResponse

PageResponse returns the current ConfigurationStoresListResponse page.

type ConfigurationStoresListResponse 

type ConfigurationStoresListResponse struct {
	ConfigurationStoresListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresListResponse contains the response from method ConfigurationStores.List.

type ConfigurationStoresListResult 

type ConfigurationStoresListResult struct {
	ConfigurationStoreListResult
}

ConfigurationStoresListResult contains the result from method ConfigurationStores.List.

type ConfigurationStoresRegenerateKeyOptions 

type ConfigurationStoresRegenerateKeyOptions struct {
}

ConfigurationStoresRegenerateKeyOptions contains the optional parameters for the ConfigurationStores.RegenerateKey method.

type ConfigurationStoresRegenerateKeyResponse 

type ConfigurationStoresRegenerateKeyResponse struct {
	ConfigurationStoresRegenerateKeyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresRegenerateKeyResponse contains the response from method ConfigurationStores.RegenerateKey.

type ConfigurationStoresRegenerateKeyResult 

type ConfigurationStoresRegenerateKeyResult struct {
	APIKey
}

ConfigurationStoresRegenerateKeyResult contains the result from method ConfigurationStores.RegenerateKey.

type ConfigurationStoresUpdatePoller 

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

ConfigurationStoresUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ConfigurationStoresUpdatePoller) Done 

func (p *ConfigurationStoresUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConfigurationStoresUpdatePoller) FinalResponse 

func (p *ConfigurationStoresUpdatePoller) FinalResponse(ctx context.Context) (ConfigurationStoresUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConfigurationStoresUpdateResponse will be returned.

func (*ConfigurationStoresUpdatePoller) Poll 

func (p *ConfigurationStoresUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConfigurationStoresUpdatePoller) ResumeToken 

func (p *ConfigurationStoresUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConfigurationStoresUpdatePollerResponse 

type ConfigurationStoresUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresUpdatePollerResponse contains the response from method ConfigurationStores.Update.

func (ConfigurationStoresUpdatePollerResponse) PollUntilDone 

func (l ConfigurationStoresUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConfigurationStoresUpdatePollerResponse) Resume 

func (l *ConfigurationStoresUpdatePollerResponse) Resume(ctx context.Context, client *ConfigurationStoresClient, token string) error

Resume rehydrates a ConfigurationStoresUpdatePollerResponse from the provided client and resume token.

type ConfigurationStoresUpdateResponse 

type ConfigurationStoresUpdateResponse struct {
	ConfigurationStoresUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConfigurationStoresUpdateResponse contains the response from method ConfigurationStores.Update.

type ConfigurationStoresUpdateResult 

type ConfigurationStoresUpdateResult struct {
	ConfigurationStore
}

ConfigurationStoresUpdateResult contains the result from method ConfigurationStores.Update.

type ConnectionStatus 

type ConnectionStatus string

ConnectionStatus - The private link service connection status. 

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

func PossibleConnectionStatusValues 

func PossibleConnectionStatusValues() []ConnectionStatus

PossibleConnectionStatusValues returns the possible values for the ConnectionStatus const type.

func (ConnectionStatus) ToPtr 

func (c ConnectionStatus) ToPtr() *ConnectionStatus

ToPtr returns a *ConnectionStatus pointing to the current value.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr 

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type EncryptionProperties 

type EncryptionProperties struct {
	// Key vault properties.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

EncryptionProperties - The encryption settings for a configuration store.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetails 

type ErrorDetails struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; Error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Error message indicating why the operation failed.
	Message *string `json:"message,omitempty" azure:"ro"`
}

ErrorDetails - The details of the error.

func (ErrorDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetails.

type ErrorResponse 

type ErrorResponse struct {

	// The details of the error.
	InnerError *ErrorDetails `json:"error,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse - Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error implements the error interface for type ErrorResponse. The contents of the error text are not contractual and subject to change.

type IdentityType 

type IdentityType string

IdentityType - The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. 

const (
	IdentityTypeNone                       IdentityType = "None"
	IdentityTypeSystemAssigned             IdentityType = "SystemAssigned"
	IdentityTypeSystemAssignedUserAssigned IdentityType = "SystemAssigned, UserAssigned"
	IdentityTypeUserAssigned               IdentityType = "UserAssigned"
)

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

func (IdentityType) ToPtr 

func (c IdentityType) ToPtr() *IdentityType

ToPtr returns a *IdentityType pointing to the current value.

type KeyValue 

type KeyValue struct {
	// All key-value properties.
	Properties *KeyValueProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

KeyValue - The key-value resource along with all resource properties.

type KeyValueListResult 

type KeyValueListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*KeyValue `json:"value,omitempty"`
}

KeyValueListResult - The result of a request to list key-values.

func (KeyValueListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KeyValueListResult.

type KeyValueProperties 

type KeyValueProperties struct {
	// 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"`

	// A dictionary of tags that can help identify what a key-value may be applicable for.
	Tags map[string]*string `json:"tags,omitempty"`

	// The value of the key-value.
	Value *string `json:"value,omitempty"`

	// READ-ONLY; An ETag indicating the state of a key-value within a configuration store.
	ETag *string `json:"eTag,omitempty" azure:"ro"`

	// 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" azure:"ro"`

	// 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" azure:"ro"`

	// READ-ONLY; The last time a modifying operation was performed on the given key-value.
	LastModified *time.Time `json:"lastModified,omitempty" azure:"ro"`

	// 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" azure:"ro"`
}

KeyValueProperties - All key-value properties.

func (KeyValueProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KeyValueProperties.

func (*KeyValueProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KeyValueProperties.

type KeyValuesBeginDeleteOptions 

type KeyValuesBeginDeleteOptions struct {
}

KeyValuesBeginDeleteOptions contains the optional parameters for the KeyValues.BeginDelete method.

type KeyValuesClient 

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

KeyValuesClient contains the methods for the KeyValues group. Don't use this type directly, use NewKeyValuesClient() instead.

func NewKeyValuesClient 

func NewKeyValuesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *KeyValuesClient

NewKeyValuesClient creates a new instance of KeyValuesClient with the specified values.

func (*KeyValuesClient) BeginDelete 

func (client *KeyValuesClient) BeginDelete(ctx context.Context, resourceGroupName string, configStoreName string, keyValueName string, options *KeyValuesBeginDeleteOptions) (KeyValuesDeletePollerResponse, error)

BeginDelete - Deletes a key-value. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresDeleteKeyValue.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewKeyValuesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<key-value-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*KeyValuesClient) CreateOrUpdate 

func (client *KeyValuesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, configStoreName string, keyValueName string, options *KeyValuesCreateOrUpdateOptions) (KeyValuesCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a key-value. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresCreateKeyValue.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewKeyValuesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<key-value-name>",
		&armappconfiguration.KeyValuesCreateOrUpdateOptions{KeyValueParameters: &armappconfiguration.KeyValue{
			Properties: &armappconfiguration.KeyValueProperties{
				Tags: map[string]*string{
					"tag1": to.StringPtr("tagValue1"),
					"tag2": to.StringPtr("tagValue2"),
				},
				Value: to.StringPtr("<value>"),
			},
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("KeyValue.ID: %s\n", *res.ID)
}

Output:

func (*KeyValuesClient) Get 

func (client *KeyValuesClient) Get(ctx context.Context, resourceGroupName string, configStoreName string, keyValueName string, options *KeyValuesGetOptions) (KeyValuesGetResponse, error)

Get - Gets the properties of the specified key-value. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresGetKeyValue.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewKeyValuesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<key-value-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("KeyValue.ID: %s\n", *res.ID)
}

Output:

func (*KeyValuesClient) ListByConfigurationStore 

func (client *KeyValuesClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *KeyValuesListByConfigurationStoreOptions) *KeyValuesListByConfigurationStorePager

ListByConfigurationStore - Lists the key-values for a given configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresListKeyValues.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewKeyValuesClient("<subscription-id>", cred, nil)
	pager := client.ListByConfigurationStore("<resource-group-name>",
		"<config-store-name>",
		&armappconfiguration.KeyValuesListByConfigurationStoreOptions{SkipToken: nil})
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("KeyValue.ID: %s\n", *v.ID)
		}
	}
}

Output:

type KeyValuesCreateOrUpdateOptions 

type KeyValuesCreateOrUpdateOptions struct {
	// The parameters for creating a key-value.
	KeyValueParameters *KeyValue
}

KeyValuesCreateOrUpdateOptions contains the optional parameters for the KeyValues.CreateOrUpdate method.

type KeyValuesCreateOrUpdateResponse 

type KeyValuesCreateOrUpdateResponse struct {
	KeyValuesCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeyValuesCreateOrUpdateResponse contains the response from method KeyValues.CreateOrUpdate.

type KeyValuesCreateOrUpdateResult 

type KeyValuesCreateOrUpdateResult struct {
	KeyValue
}

KeyValuesCreateOrUpdateResult contains the result from method KeyValues.CreateOrUpdate.

type KeyValuesDeletePoller 

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

KeyValuesDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*KeyValuesDeletePoller) Done 

func (p *KeyValuesDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*KeyValuesDeletePoller) FinalResponse 

func (p *KeyValuesDeletePoller) FinalResponse(ctx context.Context) (KeyValuesDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final KeyValuesDeleteResponse will be returned.

func (*KeyValuesDeletePoller) Poll 

func (p *KeyValuesDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*KeyValuesDeletePoller) ResumeToken 

func (p *KeyValuesDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type KeyValuesDeletePollerResponse 

type KeyValuesDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *KeyValuesDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeyValuesDeletePollerResponse contains the response from method KeyValues.Delete.

func (KeyValuesDeletePollerResponse) PollUntilDone 

func (l KeyValuesDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (KeyValuesDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*KeyValuesDeletePollerResponse) Resume 

func (l *KeyValuesDeletePollerResponse) Resume(ctx context.Context, client *KeyValuesClient, token string) error

Resume rehydrates a KeyValuesDeletePollerResponse from the provided client and resume token.

type KeyValuesDeleteResponse 

type KeyValuesDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeyValuesDeleteResponse contains the response from method KeyValues.Delete.

type KeyValuesGetOptions 

type KeyValuesGetOptions struct {
}

KeyValuesGetOptions contains the optional parameters for the KeyValues.Get method.

type KeyValuesGetResponse 

type KeyValuesGetResponse struct {
	KeyValuesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeyValuesGetResponse contains the response from method KeyValues.Get.

type KeyValuesGetResult 

type KeyValuesGetResult struct {
	KeyValue
}

KeyValuesGetResult contains the result from method KeyValues.Get.

type KeyValuesListByConfigurationStoreOptions 

type KeyValuesListByConfigurationStoreOptions struct {
	// 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.
	SkipToken *string
}

KeyValuesListByConfigurationStoreOptions contains the optional parameters for the KeyValues.ListByConfigurationStore method.

type KeyValuesListByConfigurationStorePager 

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

KeyValuesListByConfigurationStorePager provides operations for iterating over paged responses.

func (*KeyValuesListByConfigurationStorePager) Err 

func (p *KeyValuesListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*KeyValuesListByConfigurationStorePager) NextPage 

func (p *KeyValuesListByConfigurationStorePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*KeyValuesListByConfigurationStorePager) PageResponse 

func (p *KeyValuesListByConfigurationStorePager) PageResponse() KeyValuesListByConfigurationStoreResponse

PageResponse returns the current KeyValuesListByConfigurationStoreResponse page.

type KeyValuesListByConfigurationStoreResponse 

type KeyValuesListByConfigurationStoreResponse struct {
	KeyValuesListByConfigurationStoreResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeyValuesListByConfigurationStoreResponse contains the response from method KeyValues.ListByConfigurationStore.

type KeyValuesListByConfigurationStoreResult 

type KeyValuesListByConfigurationStoreResult struct {
	KeyValueListResult
}

KeyValuesListByConfigurationStoreResult contains the result from method KeyValues.ListByConfigurationStore.

type KeyVaultProperties 

type KeyVaultProperties struct {
	// The client id of the identity which will be used to access key vault.
	IdentityClientID *string `json:"identityClientId,omitempty"`

	// The URI of the key vault key used to encrypt data.
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}

KeyVaultProperties - Settings concerning key vault encryption for a configuration store.

type LogSpecification 

type LogSpecification struct {
	// Blob duration of the log
	BlobDuration *string `json:"blobDuration,omitempty"`

	// Localized friendly display name of the log
	DisplayName *string `json:"displayName,omitempty"`

	// Name of the log
	Name *string `json:"name,omitempty"`
}

LogSpecification - Specifications of the Log for Azure Monitoring

type MetricDimension 

type MetricDimension struct {
	// Localized friendly display name of the dimension
	DisplayName *string `json:"displayName,omitempty"`

	// Internal name of the dimension.
	InternalName *string `json:"internalName,omitempty"`

	// Name of the dimension
	Name *string `json:"name,omitempty"`
}

MetricDimension - Specifications of the Dimension of metrics

type MetricSpecification 

type MetricSpecification struct {
	// Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
	AggregationType *string `json:"aggregationType,omitempty"`

	// Dimensions of the metric
	Dimensions []*MetricDimension `json:"dimensions,omitempty"`

	// Localized friendly description of the metric
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Localized friendly display name of the metric
	DisplayName *string `json:"displayName,omitempty"`

	// Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// Internal metric name.
	InternalMetricName *string `json:"internalMetricName,omitempty"`

	// Name of the metric
	Name *string `json:"name,omitempty"`

	// Unit that makes sense for the metric
	Unit *string `json:"unit,omitempty"`
}

MetricSpecification - Specifications of the Metrics for Azure Monitoring

func (MetricSpecification) MarshalJSON 

func (m MetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

type NameAvailabilityStatus 

type NameAvailabilityStatus struct {
	// 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" azure:"ro"`

	// READ-ONLY; The value indicating whether the resource name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty" azure:"ro"`

	// READ-ONLY; If any, the reason that the name is not available.
	Reason *string `json:"reason,omitempty" azure:"ro"`
}

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

type OperationDefinition 

type OperationDefinition struct {
	// The display information for the configuration store operation.
	Display *OperationDefinitionDisplay `json:"display,omitempty"`

	// Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`

	// Origin of the operation
	Origin *string `json:"origin,omitempty"`

	// Properties of the operation
	Properties *OperationProperties `json:"properties,omitempty"`
}

OperationDefinition - The definition of a configuration store operation.

type OperationDefinitionDisplay 

type OperationDefinitionDisplay struct {
	// The description for the operation.
	Description *string `json:"description,omitempty"`

	// The operation that users can perform.
	Operation *string `json:"operation,omitempty"`

	// The resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`

	// READ-ONLY; The resource provider name: Microsoft App Configuration."
	Provider *string `json:"provider,omitempty" azure:"ro"`
}

OperationDefinitionDisplay - The display information for a configuration store operation.

type OperationDefinitionListResult 

type OperationDefinitionListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*OperationDefinition `json:"value,omitempty"`
}

OperationDefinitionListResult - The result of a request to list configuration store operations.

func (OperationDefinitionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationDefinitionListResult.

type OperationProperties 

type OperationProperties struct {
	// Service specifications of the operation
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - Extra Operation properties

type OperationsCheckNameAvailabilityOptions 

type OperationsCheckNameAvailabilityOptions struct {
}

OperationsCheckNameAvailabilityOptions contains the optional parameters for the Operations.CheckNameAvailability method.

type OperationsCheckNameAvailabilityResponse 

type OperationsCheckNameAvailabilityResponse struct {
	OperationsCheckNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsCheckNameAvailabilityResponse contains the response from method Operations.CheckNameAvailability.

type OperationsCheckNameAvailabilityResult 

type OperationsCheckNameAvailabilityResult struct {
	NameAvailabilityStatus
}

OperationsCheckNameAvailabilityResult contains the result from method Operations.CheckNameAvailability.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) CheckNameAvailability 

func (client *OperationsClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityParameters CheckNameAvailabilityParameters, options *OperationsCheckNameAvailabilityOptions) (OperationsCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks whether the configuration store name is available for use. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/CheckNameAvailable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewOperationsClient("<subscription-id>", cred, nil)
	_, err = client.CheckNameAvailability(ctx,
		armappconfiguration.CheckNameAvailabilityParameters{
			Name: to.StringPtr("<name>"),
			Type: armappconfiguration.ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores.ToPtr(),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsListOptions) *OperationsListPager

List - Lists the operations available from this provider. If the operation fails it returns the *ErrorResponse error type.

type OperationsListOptions 

type OperationsListOptions struct {
	// 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.
	SkipToken *string
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager 

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err 

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage 

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse 

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse 

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	OperationDefinitionListResult
}

OperationsListResult contains the result from method Operations.List.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// The resource Id for private endpoint
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint - Private endpoint which a connection belongs to.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// The properties of a private endpoint.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - A private endpoint connection

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - A list of private endpoint connections

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private endpoint.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning status of the private endpoint connection.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of a private endpoint connection.

type PrivateEndpointConnectionReference 

type PrivateEndpointConnectionReference struct {
	// The properties of a private endpoint connection.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnectionReference - A reference to a related private endpoint connection.

type PrivateEndpointConnectionsBeginCreateOrUpdateOptions 

type PrivateEndpointConnectionsBeginCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnections.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsBeginDeleteOptions 

type PrivateEndpointConnectionsBeginDeleteOptions struct {
}

PrivateEndpointConnectionsBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnections.BeginDelete method.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, configStoreName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, options *PrivateEndpointConnectionsBeginCreateOrUpdateOptions) (PrivateEndpointConnectionsCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Update the state of the specified private endpoint connection associated with the configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresCreatePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<private-endpoint-connection-name>",
		armappconfiguration.PrivateEndpointConnection{
			Properties: &armappconfiguration.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armappconfiguration.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      armappconfiguration.ConnectionStatusApproved.ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PrivateEndpointConnection.ID: %s\n", *res.ID)
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, configStoreName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsBeginDeleteOptions) (PrivateEndpointConnectionsDeletePollerResponse, error)

BeginDelete - Deletes a private endpoint connection. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresDeletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, configStoreName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsGetOptions) (PrivateEndpointConnectionsGetResponse, error)

Get - Gets the specified private endpoint connection associated with the configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresGetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PrivateEndpointConnection.ID: %s\n", *res.ID)
}

Output:

func (*PrivateEndpointConnectionsClient) ListByConfigurationStore 

func (client *PrivateEndpointConnectionsClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *PrivateEndpointConnectionsListByConfigurationStoreOptions) *PrivateEndpointConnectionsListByConfigurationStorePager

ListByConfigurationStore - Lists all private endpoint connections for a configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/ConfigurationStoresListPrivateEndpointConnections.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	pager := client.ListByConfigurationStore("<resource-group-name>",
		"<config-store-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PrivateEndpointConnection.ID: %s\n", *v.ID)
		}
	}
}

Output:

type PrivateEndpointConnectionsCreateOrUpdatePoller 

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

PrivateEndpointConnectionsCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) Done 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) FinalResponse 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsCreateOrUpdateResponse will be returned.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) Poll 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) ResumeToken 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsCreateOrUpdatePollerResponse 

type PrivateEndpointConnectionsCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsCreateOrUpdatePollerResponse contains the response from method PrivateEndpointConnections.CreateOrUpdate.

func (PrivateEndpointConnectionsCreateOrUpdatePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionsCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsCreateOrUpdatePollerResponse) Resume 

func (l *PrivateEndpointConnectionsCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsCreateOrUpdateResponse 

type PrivateEndpointConnectionsCreateOrUpdateResponse struct {
	PrivateEndpointConnectionsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsCreateOrUpdateResponse contains the response from method PrivateEndpointConnections.CreateOrUpdate.

type PrivateEndpointConnectionsCreateOrUpdateResult 

type PrivateEndpointConnectionsCreateOrUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsCreateOrUpdateResult contains the result from method PrivateEndpointConnections.CreateOrUpdate.

type PrivateEndpointConnectionsDeletePoller 

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

PrivateEndpointConnectionsDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) Done 

func (p *PrivateEndpointConnectionsDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) FinalResponse 

func (p *PrivateEndpointConnectionsDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsDeleteResponse will be returned.

func (*PrivateEndpointConnectionsDeletePoller) Poll 

func (p *PrivateEndpointConnectionsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsDeletePoller) ResumeToken 

func (p *PrivateEndpointConnectionsDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsDeletePollerResponse 

type PrivateEndpointConnectionsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeletePollerResponse contains the response from method PrivateEndpointConnections.Delete.

func (PrivateEndpointConnectionsDeletePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsDeletePollerResponse) Resume 

func (l *PrivateEndpointConnectionsDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsDeleteResponse 

type PrivateEndpointConnectionsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeleteResponse contains the response from method PrivateEndpointConnections.Delete.

type PrivateEndpointConnectionsGetOptions 

type PrivateEndpointConnectionsGetOptions struct {
}

PrivateEndpointConnectionsGetOptions contains the optional parameters for the PrivateEndpointConnections.Get method.

type PrivateEndpointConnectionsGetResponse 

type PrivateEndpointConnectionsGetResponse struct {
	PrivateEndpointConnectionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsGetResponse contains the response from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsGetResult 

type PrivateEndpointConnectionsGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsGetResult contains the result from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsListByConfigurationStoreOptions 

type PrivateEndpointConnectionsListByConfigurationStoreOptions struct {
}

PrivateEndpointConnectionsListByConfigurationStoreOptions contains the optional parameters for the PrivateEndpointConnections.ListByConfigurationStore method.

type PrivateEndpointConnectionsListByConfigurationStorePager 

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

PrivateEndpointConnectionsListByConfigurationStorePager provides operations for iterating over paged responses.

func (*PrivateEndpointConnectionsListByConfigurationStorePager) Err 

func (p *PrivateEndpointConnectionsListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*PrivateEndpointConnectionsListByConfigurationStorePager) NextPage 

func (p *PrivateEndpointConnectionsListByConfigurationStorePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateEndpointConnectionsListByConfigurationStorePager) PageResponse 

func (p *PrivateEndpointConnectionsListByConfigurationStorePager) PageResponse() PrivateEndpointConnectionsListByConfigurationStoreResponse

PageResponse returns the current PrivateEndpointConnectionsListByConfigurationStoreResponse page.

type PrivateEndpointConnectionsListByConfigurationStoreResponse 

type PrivateEndpointConnectionsListByConfigurationStoreResponse struct {
	PrivateEndpointConnectionsListByConfigurationStoreResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsListByConfigurationStoreResponse contains the response from method PrivateEndpointConnections.ListByConfigurationStore.

type PrivateEndpointConnectionsListByConfigurationStoreResult 

type PrivateEndpointConnectionsListByConfigurationStoreResult struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsListByConfigurationStoreResult contains the result from method PrivateEndpointConnections.ListByConfigurationStore.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Private link resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A resource that supports private link capabilities.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string `json:"nextLink,omitempty"`

	// The collection value.
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources.

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`

	// READ-ONLY; The list of required DNS zone names of the private link resource.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

func (*PrivateLinkResourcesClient) Get 

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, configStoreName string, groupName string, options *PrivateLinkResourcesGetOptions) (PrivateLinkResourcesGetResponse, error)

Get - Gets a private link resource that need to be created for a configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/PrivateLinkResourceGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<config-store-name>",
		"<group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("PrivateLinkResource.ID: %s\n", *res.ID)
}

Output:

func (*PrivateLinkResourcesClient) ListByConfigurationStore 

func (client *PrivateLinkResourcesClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *PrivateLinkResourcesListByConfigurationStoreOptions) *PrivateLinkResourcesListByConfigurationStorePager

ListByConfigurationStore - Gets the private link resources that need to be created for a configuration store. If the operation fails it returns the *ErrorResponse error type.

Example

x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/examples/PrivateLinkResourcesListByConfigurationStore.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armappconfiguration.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	pager := client.ListByConfigurationStore("<resource-group-name>",
		"<config-store-name>",
		nil)
	for pager.NextPage(ctx) {
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("PrivateLinkResource.ID: %s\n", *v.ID)
		}
	}
}

Output:

type PrivateLinkResourcesGetOptions 

type PrivateLinkResourcesGetOptions struct {
}

PrivateLinkResourcesGetOptions contains the optional parameters for the PrivateLinkResources.Get method.

type PrivateLinkResourcesGetResponse 

type PrivateLinkResourcesGetResponse struct {
	PrivateLinkResourcesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesGetResponse contains the response from method PrivateLinkResources.Get.

type PrivateLinkResourcesGetResult 

type PrivateLinkResourcesGetResult struct {
	PrivateLinkResource
}

PrivateLinkResourcesGetResult contains the result from method PrivateLinkResources.Get.

type PrivateLinkResourcesListByConfigurationStoreOptions 

type PrivateLinkResourcesListByConfigurationStoreOptions struct {
}

PrivateLinkResourcesListByConfigurationStoreOptions contains the optional parameters for the PrivateLinkResources.ListByConfigurationStore method.

type PrivateLinkResourcesListByConfigurationStorePager 

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

PrivateLinkResourcesListByConfigurationStorePager provides operations for iterating over paged responses.

func (*PrivateLinkResourcesListByConfigurationStorePager) Err 

func (p *PrivateLinkResourcesListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkResourcesListByConfigurationStorePager) NextPage 

func (p *PrivateLinkResourcesListByConfigurationStorePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkResourcesListByConfigurationStorePager) PageResponse 

func (p *PrivateLinkResourcesListByConfigurationStorePager) PageResponse() PrivateLinkResourcesListByConfigurationStoreResponse

PageResponse returns the current PrivateLinkResourcesListByConfigurationStoreResponse page.

type PrivateLinkResourcesListByConfigurationStoreResponse 

type PrivateLinkResourcesListByConfigurationStoreResponse struct {
	PrivateLinkResourcesListByConfigurationStoreResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesListByConfigurationStoreResponse contains the response from method PrivateLinkResources.ListByConfigurationStore.

type PrivateLinkResourcesListByConfigurationStoreResult 

type PrivateLinkResourcesListByConfigurationStoreResult struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesListByConfigurationStoreResult contains the result from method PrivateLinkResources.ListByConfigurationStore.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// The private link service connection description.
	Description *string `json:"description,omitempty"`

	// The private link service connection status.
	Status *ConnectionStatus `json:"status,omitempty"`

	// READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
	ActionsRequired *ActionsRequired `json:"actionsRequired,omitempty" azure:"ro"`
}

PrivateLinkServiceConnectionState - The state of a private link service connection.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The provisioning state of the configuration store. 

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

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Control permission for data plane traffic coming from public networks while private endpoint is enabled. 

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

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr 

func (c PublicNetworkAccess) ToPtr() *PublicNetworkAccess

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	// 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 {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceIdentity 

type ResourceIdentity struct {
	// The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities.
	// The type 'None' will remove any
	// identities.
	Type *IdentityType `json:"type,omitempty"`

	// The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*UserIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal id of the identity. This property will only be provided for a system-assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ResourceIdentity - An identity that can be associated with a resource.

func (ResourceIdentity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceIdentity.

type SKU 

type SKU struct {
	// REQUIRED; The SKU name of the configuration store.
	Name *string `json:"name,omitempty"`
}

SKU - Describes a configuration store SKU.

type ServiceSpecification 

type ServiceSpecification struct {
	// Specifications of the Log for Azure Monitoring
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty"`

	// Specifications of the Metrics for Azure Monitoring
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - Service specification payload

func (ServiceSpecification) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TrackedResource 

type TrackedResource struct {
	Resource
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type UserIdentity 

type UserIdentity struct {
	// READ-ONLY; The client ID of the user-assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID of the user-assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserIdentity - A resource identity that is managed by the user of the service.

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.