armappconfiguration

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Jan 13, 2022 License: MIT Imports: 14 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 {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// 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"`

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

	// 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; Resource system metadata.
	SystemData *SystemData `json:"systemData,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"`
}

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 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. subscriptionID - The Microsoft Azure subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ConfigurationStoresClient) BeginCreate 

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

BeginCreate - Creates a configuration store with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. configStoreCreationParameters - The parameters for creating a configuration store. options - ConfigurationStoresClientBeginCreateOptions contains the optional parameters for the ConfigurationStoresClient.BeginCreate method.

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{
			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("Response result: %#v\n", res.ConfigurationStoresClientCreateResult)
}

Output:

func (*ConfigurationStoresClient) BeginDelete 

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

BeginDelete - Deletes a configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - ConfigurationStoresClientBeginDeleteOptions contains the optional parameters for the ConfigurationStoresClient.BeginDelete method.

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 *ConfigurationStoresClientBeginUpdateOptions) (ConfigurationStoresClientUpdatePollerResponse, error)

BeginUpdate - Updates a configuration store with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. configStoreUpdateParameters - The parameters for updating a configuration store. options - ConfigurationStoresClientBeginUpdateOptions contains the optional parameters for the ConfigurationStoresClient.BeginUpdate method.

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("Response result: %#v\n", res.ConfigurationStoresClientUpdateResult)
}

Output:

func (*ConfigurationStoresClient) Get 

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

Get - Gets the properties of the specified configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - ConfigurationStoresClientGetOptions contains the optional parameters for the ConfigurationStoresClient.Get method.

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("Response result: %#v\n", res.ConfigurationStoresClientGetResult)
}

Output:

func (*ConfigurationStoresClient) List 

func (client *ConfigurationStoresClient) List(options *ConfigurationStoresClientListOptions) *ConfigurationStoresClientListPager

List - Lists the configuration stores for a given subscription. If the operation fails it returns an *azcore.ResponseError type. options - ConfigurationStoresClientListOptions contains the optional parameters for the ConfigurationStoresClient.List method.

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.ConfigurationStoresClientListOptions{SkipToken: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ConfigurationStoresClient) ListByResourceGroup 

func (client *ConfigurationStoresClient) ListByResourceGroup(resourceGroupName string, options *ConfigurationStoresClientListByResourceGroupOptions) *ConfigurationStoresClientListByResourceGroupPager

ListByResourceGroup - Lists the configuration stores for a given resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. options - ConfigurationStoresClientListByResourceGroupOptions contains the optional parameters for the ConfigurationStoresClient.ListByResourceGroup method.

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.ConfigurationStoresClientListByResourceGroupOptions{SkipToken: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ConfigurationStoresClient) ListKeys 

func (client *ConfigurationStoresClient) ListKeys(resourceGroupName string, configStoreName string, options *ConfigurationStoresClientListKeysOptions) *ConfigurationStoresClientListKeysPager

ListKeys - Lists the access key for the specified configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - ConfigurationStoresClientListKeysOptions contains the optional parameters for the ConfigurationStoresClient.ListKeys method.

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.ConfigurationStoresClientListKeysOptions{SkipToken: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ConfigurationStoresClient) RegenerateKey 

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

RegenerateKey - Regenerates an access key for the specified configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. regenerateKeyParameters - The parameters for regenerating an access key. options - ConfigurationStoresClientRegenerateKeyOptions contains the optional parameters for the ConfigurationStoresClient.RegenerateKey method.

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("Response result: %#v\n", res.ConfigurationStoresClientRegenerateKeyResult)
}

Output:

type ConfigurationStoresClientBeginCreateOptions added in v0.2.0 

type ConfigurationStoresClientBeginCreateOptions struct {
}

ConfigurationStoresClientBeginCreateOptions contains the optional parameters for the ConfigurationStoresClient.BeginCreate method.

type ConfigurationStoresClientBeginDeleteOptions added in v0.2.0 

type ConfigurationStoresClientBeginDeleteOptions struct {
}

ConfigurationStoresClientBeginDeleteOptions contains the optional parameters for the ConfigurationStoresClient.BeginDelete method.

type ConfigurationStoresClientBeginUpdateOptions added in v0.2.0 

type ConfigurationStoresClientBeginUpdateOptions struct {
}

ConfigurationStoresClientBeginUpdateOptions contains the optional parameters for the ConfigurationStoresClient.BeginUpdate method.

type ConfigurationStoresClientCreatePoller added in v0.2.0 

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

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

func (*ConfigurationStoresClientCreatePoller) Done added in v0.2.0 

func (p *ConfigurationStoresClientCreatePoller) Done() bool

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

func (*ConfigurationStoresClientCreatePoller) FinalResponse added in v0.2.0 

func (p *ConfigurationStoresClientCreatePoller) FinalResponse(ctx context.Context) (ConfigurationStoresClientCreateResponse, 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 ConfigurationStoresClientCreateResponse will be returned.

func (*ConfigurationStoresClientCreatePoller) Poll added in v0.2.0 

func (p *ConfigurationStoresClientCreatePoller) 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 (*ConfigurationStoresClientCreatePoller) ResumeToken added in v0.2.0 

func (p *ConfigurationStoresClientCreatePoller) 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 ConfigurationStoresClientCreatePollerResponse added in v0.2.0 

type ConfigurationStoresClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresClientCreatePoller

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

ConfigurationStoresClientCreatePollerResponse contains the response from method ConfigurationStoresClient.Create.

func (ConfigurationStoresClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l ConfigurationStoresClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresClientCreateResponse, 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 (*ConfigurationStoresClientCreatePollerResponse) Resume added in v0.2.0 

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

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

type ConfigurationStoresClientCreateResponse added in v0.2.0 

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

ConfigurationStoresClientCreateResponse contains the response from method ConfigurationStoresClient.Create.

type ConfigurationStoresClientCreateResult added in v0.2.0 

type ConfigurationStoresClientCreateResult struct {
	ConfigurationStore
}

ConfigurationStoresClientCreateResult contains the result from method ConfigurationStoresClient.Create.

type ConfigurationStoresClientDeletePoller added in v0.2.0 

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

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

func (*ConfigurationStoresClientDeletePoller) Done added in v0.2.0 

func (p *ConfigurationStoresClientDeletePoller) Done() bool

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

func (*ConfigurationStoresClientDeletePoller) FinalResponse added in v0.2.0 

func (p *ConfigurationStoresClientDeletePoller) FinalResponse(ctx context.Context) (ConfigurationStoresClientDeleteResponse, 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 ConfigurationStoresClientDeleteResponse will be returned.

func (*ConfigurationStoresClientDeletePoller) Poll added in v0.2.0 

func (p *ConfigurationStoresClientDeletePoller) 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 (*ConfigurationStoresClientDeletePoller) ResumeToken added in v0.2.0 

func (p *ConfigurationStoresClientDeletePoller) 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 ConfigurationStoresClientDeletePollerResponse added in v0.2.0 

type ConfigurationStoresClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresClientDeletePoller

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

ConfigurationStoresClientDeletePollerResponse contains the response from method ConfigurationStoresClient.Delete.

func (ConfigurationStoresClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l ConfigurationStoresClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresClientDeleteResponse, 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 (*ConfigurationStoresClientDeletePollerResponse) Resume added in v0.2.0 

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

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

type ConfigurationStoresClientDeleteResponse added in v0.2.0 

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

ConfigurationStoresClientDeleteResponse contains the response from method ConfigurationStoresClient.Delete.

type ConfigurationStoresClientGetOptions added in v0.2.0 

type ConfigurationStoresClientGetOptions struct {
}

ConfigurationStoresClientGetOptions contains the optional parameters for the ConfigurationStoresClient.Get method.

type ConfigurationStoresClientGetResponse added in v0.2.0 

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

ConfigurationStoresClientGetResponse contains the response from method ConfigurationStoresClient.Get.

type ConfigurationStoresClientGetResult added in v0.2.0 

type ConfigurationStoresClientGetResult struct {
	ConfigurationStore
}

ConfigurationStoresClientGetResult contains the result from method ConfigurationStoresClient.Get.

type ConfigurationStoresClientListByResourceGroupOptions added in v0.2.0 

type ConfigurationStoresClientListByResourceGroupOptions 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
}

ConfigurationStoresClientListByResourceGroupOptions contains the optional parameters for the ConfigurationStoresClient.ListByResourceGroup method.

type ConfigurationStoresClientListByResourceGroupPager added in v0.2.0 

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

ConfigurationStoresClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ConfigurationStoresClientListByResourceGroupPager) Err added in v0.2.0 

func (p *ConfigurationStoresClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresClientListByResourceGroupPager) NextPage added in v0.2.0 

func (p *ConfigurationStoresClientListByResourceGroupPager) 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 (*ConfigurationStoresClientListByResourceGroupPager) PageResponse added in v0.2.0 

func (p *ConfigurationStoresClientListByResourceGroupPager) PageResponse() ConfigurationStoresClientListByResourceGroupResponse

PageResponse returns the current ConfigurationStoresClientListByResourceGroupResponse page.

type ConfigurationStoresClientListByResourceGroupResponse added in v0.2.0 

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

ConfigurationStoresClientListByResourceGroupResponse contains the response from method ConfigurationStoresClient.ListByResourceGroup.

type ConfigurationStoresClientListByResourceGroupResult added in v0.2.0 

type ConfigurationStoresClientListByResourceGroupResult struct {
	ConfigurationStoreListResult
}

ConfigurationStoresClientListByResourceGroupResult contains the result from method ConfigurationStoresClient.ListByResourceGroup.

type ConfigurationStoresClientListKeysOptions added in v0.2.0 

type ConfigurationStoresClientListKeysOptions 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
}

ConfigurationStoresClientListKeysOptions contains the optional parameters for the ConfigurationStoresClient.ListKeys method.

type ConfigurationStoresClientListKeysPager added in v0.2.0 

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

ConfigurationStoresClientListKeysPager provides operations for iterating over paged responses.

func (*ConfigurationStoresClientListKeysPager) Err added in v0.2.0 

func (p *ConfigurationStoresClientListKeysPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresClientListKeysPager) NextPage added in v0.2.0 

func (p *ConfigurationStoresClientListKeysPager) 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 (*ConfigurationStoresClientListKeysPager) PageResponse added in v0.2.0 

func (p *ConfigurationStoresClientListKeysPager) PageResponse() ConfigurationStoresClientListKeysResponse

PageResponse returns the current ConfigurationStoresClientListKeysResponse page.

type ConfigurationStoresClientListKeysResponse added in v0.2.0 

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

ConfigurationStoresClientListKeysResponse contains the response from method ConfigurationStoresClient.ListKeys.

type ConfigurationStoresClientListKeysResult added in v0.2.0 

type ConfigurationStoresClientListKeysResult struct {
	APIKeyListResult
}

ConfigurationStoresClientListKeysResult contains the result from method ConfigurationStoresClient.ListKeys.

type ConfigurationStoresClientListOptions added in v0.2.0 

type ConfigurationStoresClientListOptions 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
}

ConfigurationStoresClientListOptions contains the optional parameters for the ConfigurationStoresClient.List method.

type ConfigurationStoresClientListPager added in v0.2.0 

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

ConfigurationStoresClientListPager provides operations for iterating over paged responses.

func (*ConfigurationStoresClientListPager) Err added in v0.2.0 

func (p *ConfigurationStoresClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ConfigurationStoresClientListPager) NextPage added in v0.2.0 

func (p *ConfigurationStoresClientListPager) 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 (*ConfigurationStoresClientListPager) PageResponse added in v0.2.0 

func (p *ConfigurationStoresClientListPager) PageResponse() ConfigurationStoresClientListResponse

PageResponse returns the current ConfigurationStoresClientListResponse page.

type ConfigurationStoresClientListResponse added in v0.2.0 

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

ConfigurationStoresClientListResponse contains the response from method ConfigurationStoresClient.List.

type ConfigurationStoresClientListResult added in v0.2.0 

type ConfigurationStoresClientListResult struct {
	ConfigurationStoreListResult
}

ConfigurationStoresClientListResult contains the result from method ConfigurationStoresClient.List.

type ConfigurationStoresClientRegenerateKeyOptions added in v0.2.0 

type ConfigurationStoresClientRegenerateKeyOptions struct {
}

ConfigurationStoresClientRegenerateKeyOptions contains the optional parameters for the ConfigurationStoresClient.RegenerateKey method.

type ConfigurationStoresClientRegenerateKeyResponse added in v0.2.0 

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

ConfigurationStoresClientRegenerateKeyResponse contains the response from method ConfigurationStoresClient.RegenerateKey.

type ConfigurationStoresClientRegenerateKeyResult added in v0.2.0 

type ConfigurationStoresClientRegenerateKeyResult struct {
	APIKey
}

ConfigurationStoresClientRegenerateKeyResult contains the result from method ConfigurationStoresClient.RegenerateKey.

type ConfigurationStoresClientUpdatePoller added in v0.2.0 

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

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

func (*ConfigurationStoresClientUpdatePoller) Done added in v0.2.0 

func (p *ConfigurationStoresClientUpdatePoller) Done() bool

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

func (*ConfigurationStoresClientUpdatePoller) FinalResponse added in v0.2.0 

func (p *ConfigurationStoresClientUpdatePoller) FinalResponse(ctx context.Context) (ConfigurationStoresClientUpdateResponse, 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 ConfigurationStoresClientUpdateResponse will be returned.

func (*ConfigurationStoresClientUpdatePoller) Poll added in v0.2.0 

func (p *ConfigurationStoresClientUpdatePoller) 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 (*ConfigurationStoresClientUpdatePoller) ResumeToken added in v0.2.0 

func (p *ConfigurationStoresClientUpdatePoller) 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 ConfigurationStoresClientUpdatePollerResponse added in v0.2.0 

type ConfigurationStoresClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConfigurationStoresClientUpdatePoller

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

ConfigurationStoresClientUpdatePollerResponse contains the response from method ConfigurationStoresClient.Update.

func (ConfigurationStoresClientUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l ConfigurationStoresClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConfigurationStoresClientUpdateResponse, 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 (*ConfigurationStoresClientUpdatePollerResponse) Resume added in v0.2.0 

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

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

type ConfigurationStoresClientUpdateResponse added in v0.2.0 

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

ConfigurationStoresClientUpdateResponse contains the response from method ConfigurationStoresClient.Update.

type ConfigurationStoresClientUpdateResult added in v0.2.0 

type ConfigurationStoresClientUpdateResult struct {
	ConfigurationStore
}

ConfigurationStoresClientUpdateResult contains the result from method ConfigurationStoresClient.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.
	Error *ErrorDetails `json:"error,omitempty"`
}

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

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 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. subscriptionID - The Microsoft Azure subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*KeyValuesClient) BeginDelete 

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

BeginDelete - Deletes a key-value. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional. options - KeyValuesClientBeginDeleteOptions contains the optional parameters for the KeyValuesClient.BeginDelete method.

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 *KeyValuesClientCreateOrUpdateOptions) (KeyValuesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a key-value. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional. options - KeyValuesClientCreateOrUpdateOptions contains the optional parameters for the KeyValuesClient.CreateOrUpdate method.

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.KeyValuesClientCreateOrUpdateOptions{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("Response result: %#v\n", res.KeyValuesClientCreateOrUpdateResult)
}

Output:

func (*KeyValuesClient) Get 

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

Get - Gets the properties of the specified key-value. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional. options - KeyValuesClientGetOptions contains the optional parameters for the KeyValuesClient.Get method.

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("Response result: %#v\n", res.KeyValuesClientGetResult)
}

Output:

func (*KeyValuesClient) ListByConfigurationStore 

func (client *KeyValuesClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *KeyValuesClientListByConfigurationStoreOptions) *KeyValuesClientListByConfigurationStorePager

ListByConfigurationStore - Lists the key-values for a given configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - KeyValuesClientListByConfigurationStoreOptions contains the optional parameters for the KeyValuesClient.ListByConfigurationStore method.

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.KeyValuesClientListByConfigurationStoreOptions{SkipToken: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type KeyValuesClientBeginDeleteOptions added in v0.2.0 

type KeyValuesClientBeginDeleteOptions struct {
}

KeyValuesClientBeginDeleteOptions contains the optional parameters for the KeyValuesClient.BeginDelete method.

type KeyValuesClientCreateOrUpdateOptions added in v0.2.0 

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

KeyValuesClientCreateOrUpdateOptions contains the optional parameters for the KeyValuesClient.CreateOrUpdate method.

type KeyValuesClientCreateOrUpdateResponse added in v0.2.0 

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

KeyValuesClientCreateOrUpdateResponse contains the response from method KeyValuesClient.CreateOrUpdate.

type KeyValuesClientCreateOrUpdateResult added in v0.2.0 

type KeyValuesClientCreateOrUpdateResult struct {
	KeyValue
}

KeyValuesClientCreateOrUpdateResult contains the result from method KeyValuesClient.CreateOrUpdate.

type KeyValuesClientDeletePoller added in v0.2.0 

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

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

func (*KeyValuesClientDeletePoller) Done added in v0.2.0 

func (p *KeyValuesClientDeletePoller) Done() bool

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

func (*KeyValuesClientDeletePoller) FinalResponse added in v0.2.0 

func (p *KeyValuesClientDeletePoller) FinalResponse(ctx context.Context) (KeyValuesClientDeleteResponse, 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 KeyValuesClientDeleteResponse will be returned.

func (*KeyValuesClientDeletePoller) Poll added in v0.2.0 

func (p *KeyValuesClientDeletePoller) 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 (*KeyValuesClientDeletePoller) ResumeToken added in v0.2.0 

func (p *KeyValuesClientDeletePoller) 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 KeyValuesClientDeletePollerResponse added in v0.2.0 

type KeyValuesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *KeyValuesClientDeletePoller

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

KeyValuesClientDeletePollerResponse contains the response from method KeyValuesClient.Delete.

func (KeyValuesClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l KeyValuesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (KeyValuesClientDeleteResponse, 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 (*KeyValuesClientDeletePollerResponse) Resume added in v0.2.0 

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

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

type KeyValuesClientDeleteResponse added in v0.2.0 

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

KeyValuesClientDeleteResponse contains the response from method KeyValuesClient.Delete.

type KeyValuesClientGetOptions added in v0.2.0 

type KeyValuesClientGetOptions struct {
}

KeyValuesClientGetOptions contains the optional parameters for the KeyValuesClient.Get method.

type KeyValuesClientGetResponse added in v0.2.0 

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

KeyValuesClientGetResponse contains the response from method KeyValuesClient.Get.

type KeyValuesClientGetResult added in v0.2.0 

type KeyValuesClientGetResult struct {
	KeyValue
}

KeyValuesClientGetResult contains the result from method KeyValuesClient.Get.

type KeyValuesClientListByConfigurationStoreOptions added in v0.2.0 

type KeyValuesClientListByConfigurationStoreOptions 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
}

KeyValuesClientListByConfigurationStoreOptions contains the optional parameters for the KeyValuesClient.ListByConfigurationStore method.

type KeyValuesClientListByConfigurationStorePager added in v0.2.0 

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

KeyValuesClientListByConfigurationStorePager provides operations for iterating over paged responses.

func (*KeyValuesClientListByConfigurationStorePager) Err added in v0.2.0 

func (p *KeyValuesClientListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*KeyValuesClientListByConfigurationStorePager) NextPage added in v0.2.0 

func (p *KeyValuesClientListByConfigurationStorePager) 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 (*KeyValuesClientListByConfigurationStorePager) PageResponse added in v0.2.0 

func (p *KeyValuesClientListByConfigurationStorePager) PageResponse() KeyValuesClientListByConfigurationStoreResponse

PageResponse returns the current KeyValuesClientListByConfigurationStoreResponse page.

type KeyValuesClientListByConfigurationStoreResponse added in v0.2.0 

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

KeyValuesClientListByConfigurationStoreResponse contains the response from method KeyValuesClient.ListByConfigurationStore.

type KeyValuesClientListByConfigurationStoreResult added in v0.2.0 

type KeyValuesClientListByConfigurationStoreResult struct {
	KeyValueListResult
}

KeyValuesClientListByConfigurationStoreResult contains the result from method KeyValuesClient.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 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. subscriptionID - The Microsoft Azure subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) CheckNameAvailability 

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

CheckNameAvailability - Checks whether the configuration store name is available for use. If the operation fails it returns an *azcore.ResponseError type. checkNameAvailabilityParameters - The object containing information for the availability request. options - OperationsClientCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.CheckNameAvailability method.

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)
	res, err := client.CheckNameAvailability(ctx,
		armappconfiguration.CheckNameAvailabilityParameters{
			Name: to.StringPtr("<name>"),
			Type: armappconfiguration.ConfigurationResourceType("Microsoft.AppConfiguration/configurationStores").ToPtr(),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.OperationsClientCheckNameAvailabilityResult)
}

Output:

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists the operations available from this provider. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientCheckNameAvailabilityOptions added in v0.2.0 

type OperationsClientCheckNameAvailabilityOptions struct {
}

OperationsClientCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.CheckNameAvailability method.

type OperationsClientCheckNameAvailabilityResponse added in v0.2.0 

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

OperationsClientCheckNameAvailabilityResponse contains the response from method OperationsClient.CheckNameAvailability.

type OperationsClientCheckNameAvailabilityResult added in v0.2.0 

type OperationsClientCheckNameAvailabilityResult struct {
	NameAvailabilityStatus
}

OperationsClientCheckNameAvailabilityResult contains the result from method OperationsClient.CheckNameAvailability.

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions 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
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.2.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.2.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.2.0 

func (p *OperationsClientListPager) 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 (*OperationsClientListPager) PageResponse added in v0.2.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.2.0 

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

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.2.0 

type OperationsClientListResult struct {
	OperationDefinitionListResult
}

OperationsClientListResult contains the result from method OperationsClient.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 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. subscriptionID - The Microsoft Azure subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

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

BeginCreateOrUpdate - Update the state of the specified private endpoint connection associated with the configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. privateEndpointConnectionName - Private endpoint connection name privateEndpointConnection - The private endpoint connection properties. options - PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

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.ConnectionStatus("Approved").ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientCreateOrUpdateResult)
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

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

BeginDelete - Deletes a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. privateEndpointConnectionName - Private endpoint connection name options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

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 *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. privateEndpointConnectionName - Private endpoint connection name options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

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("Response result: %#v\n", res.PrivateEndpointConnectionsClientGetResult)
}

Output:

func (*PrivateEndpointConnectionsClient) ListByConfigurationStore 

func (client *PrivateEndpointConnectionsClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *PrivateEndpointConnectionsClientListByConfigurationStoreOptions) *PrivateEndpointConnectionsClientListByConfigurationStorePager

ListByConfigurationStore - Lists all private endpoint connections for a configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - PrivateEndpointConnectionsClientListByConfigurationStoreOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByConfigurationStore method.

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 {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOrUpdatePoller added in v0.2.0 

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

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

func (*PrivateEndpointConnectionsClientCreateOrUpdatePoller) Done added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreateOrUpdatePoller) Done() bool

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

func (*PrivateEndpointConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, 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 PrivateEndpointConnectionsClientCreateOrUpdateResponse will be returned.

func (*PrivateEndpointConnectionsClientCreateOrUpdatePoller) Poll added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreateOrUpdatePoller) 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 (*PrivateEndpointConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreateOrUpdatePoller) 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 PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientCreateOrUpdatePoller

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

PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

func (PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, 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 (*PrivateEndpointConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.2.0 

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

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

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.2.0 

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

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientCreateOrUpdateResult added in v0.2.0 

type PrivateEndpointConnectionsClientCreateOrUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResult contains the result from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeletePoller added in v0.2.0 

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

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

func (*PrivateEndpointConnectionsClientDeletePoller) Done added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Done() bool

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

func (*PrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientDeleteResponse, 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 PrivateEndpointConnectionsClientDeleteResponse will be returned.

func (*PrivateEndpointConnectionsClientDeletePoller) Poll added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) 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 (*PrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) 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 PrivateEndpointConnectionsClientDeletePollerResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientDeletePoller

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

PrivateEndpointConnectionsClientDeletePollerResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

func (PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientDeleteResponse, 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 (*PrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.2.0 

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

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

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

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

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

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

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientGetResult added in v0.2.0 

type PrivateEndpointConnectionsClientGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResult contains the result from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByConfigurationStoreOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListByConfigurationStoreOptions struct {
}

PrivateEndpointConnectionsClientListByConfigurationStoreOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByConfigurationStore method.

type PrivateEndpointConnectionsClientListByConfigurationStorePager added in v0.2.0 

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

PrivateEndpointConnectionsClientListByConfigurationStorePager provides operations for iterating over paged responses.

func (*PrivateEndpointConnectionsClientListByConfigurationStorePager) Err added in v0.2.0 

func (p *PrivateEndpointConnectionsClientListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*PrivateEndpointConnectionsClientListByConfigurationStorePager) NextPage added in v0.2.0 

func (p *PrivateEndpointConnectionsClientListByConfigurationStorePager) 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 (*PrivateEndpointConnectionsClientListByConfigurationStorePager) PageResponse added in v0.2.0 

func (p *PrivateEndpointConnectionsClientListByConfigurationStorePager) PageResponse() PrivateEndpointConnectionsClientListByConfigurationStoreResponse

PageResponse returns the current PrivateEndpointConnectionsClientListByConfigurationStoreResponse page.

type PrivateEndpointConnectionsClientListByConfigurationStoreResponse added in v0.2.0 

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

PrivateEndpointConnectionsClientListByConfigurationStoreResponse contains the response from method PrivateEndpointConnectionsClient.ListByConfigurationStore.

type PrivateEndpointConnectionsClientListByConfigurationStoreResult added in v0.2.0 

type PrivateEndpointConnectionsClientListByConfigurationStoreResult struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByConfigurationStoreResult contains the result from method PrivateEndpointConnectionsClient.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. subscriptionID - The Microsoft Azure subscription ID. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

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

Get - Gets a private link resource that need to be created for a configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. groupName - The name of the private link resource group. options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

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("Response result: %#v\n", res.PrivateLinkResourcesClientGetResult)
}

Output:

func (*PrivateLinkResourcesClient) ListByConfigurationStore 

func (client *PrivateLinkResourcesClient) ListByConfigurationStore(resourceGroupName string, configStoreName string, options *PrivateLinkResourcesClientListByConfigurationStoreOptions) *PrivateLinkResourcesClientListByConfigurationStorePager

ListByConfigurationStore - Gets the private link resources that need to be created for a configuration store. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group to which the container registry belongs. configStoreName - The name of the configuration store. options - PrivateLinkResourcesClientListByConfigurationStoreOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByConfigurationStore method.

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 {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PrivateLinkResourcesClientGetOptions added in v0.2.0 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.2.0 

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

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientGetResult added in v0.2.0 

type PrivateLinkResourcesClientGetResult struct {
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResult contains the result from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByConfigurationStoreOptions added in v0.2.0 

type PrivateLinkResourcesClientListByConfigurationStoreOptions struct {
}

PrivateLinkResourcesClientListByConfigurationStoreOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByConfigurationStore method.

type PrivateLinkResourcesClientListByConfigurationStorePager added in v0.2.0 

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

PrivateLinkResourcesClientListByConfigurationStorePager provides operations for iterating over paged responses.

func (*PrivateLinkResourcesClientListByConfigurationStorePager) Err added in v0.2.0 

func (p *PrivateLinkResourcesClientListByConfigurationStorePager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkResourcesClientListByConfigurationStorePager) NextPage added in v0.2.0 

func (p *PrivateLinkResourcesClientListByConfigurationStorePager) 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 (*PrivateLinkResourcesClientListByConfigurationStorePager) PageResponse added in v0.2.0 

func (p *PrivateLinkResourcesClientListByConfigurationStorePager) PageResponse() PrivateLinkResourcesClientListByConfigurationStoreResponse

PageResponse returns the current PrivateLinkResourcesClientListByConfigurationStoreResponse page.

type PrivateLinkResourcesClientListByConfigurationStoreResponse added in v0.2.0 

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

PrivateLinkResourcesClientListByConfigurationStoreResponse contains the response from method PrivateLinkResourcesClient.ListByConfigurationStore.

type PrivateLinkResourcesClientListByConfigurationStoreResult added in v0.2.0 

type PrivateLinkResourcesClientListByConfigurationStoreResult struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByConfigurationStoreResult contains the result from method PrivateLinkResourcesClient.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

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 {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

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

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

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.