armappconfiguration

package module
v2.1.0 Latest Latest
Warning

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

Go to latest
Published: Nov 23, 2023 License: MIT Imports: 14 Imported by: 1

README

Azure App Configuration Module for Go

PkgGoDev

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

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

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.

Client Factory

Azure App Configuration module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armappconfiguration.NewClientFactory(<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 {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armappconfiguration.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewConfigurationStoresClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

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

	// READ-ONLY; The key ID.
	ID *string

	// READ-ONLY; The last time any of the key's properties were modified.
	LastModified *time.Time

	// READ-ONLY; A name for the key describing its usage.
	Name *string

	// READ-ONLY; Whether this key can only be used for read operations.
	ReadOnly *bool

	// READ-ONLY; The value of the key that is used for authentication purposes.
	Value *string
}

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

	// The collection value.
	Value []*APIKey
}

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.

func (*APIKeyListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	// REQUIRED; The name to check for availability.
	Name *string

	// REQUIRED; The resource type to check for name availability.
	Type *ConfigurationResourceType
}

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

func (CheckNameAvailabilityParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityParameters.

func (*CheckNameAvailabilityParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityParameters.

type ClientFactory

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • 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 (*ClientFactory) NewConfigurationStoresClient

func (c *ClientFactory) NewConfigurationStoresClient() *ConfigurationStoresClient

NewConfigurationStoresClient creates a new instance of ConfigurationStoresClient.

func (*ClientFactory) NewKeyValuesClient

func (c *ClientFactory) NewKeyValuesClient() *KeyValuesClient

NewKeyValuesClient creates a new instance of KeyValuesClient.

func (*ClientFactory) NewOperationsClient

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewReplicasClient

func (c *ClientFactory) NewReplicasClient() *ReplicasClient

NewReplicasClient creates a new instance of ReplicasClient.

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.

type ConfigurationStore

type ConfigurationStore struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The sku of the configuration store.
	SKU *SKU

	// The managed identity information, if configured.
	Identity *ResourceIdentity

	// The properties of a configuration store.
	Properties *ConfigurationStoreProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

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

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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.

func (*ConfigurationStore) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// The collection value.
	Value []*ConfigurationStore
}

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.

func (*ConfigurationStoreListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationStoreListResult.

type ConfigurationStoreProperties

type ConfigurationStoreProperties struct {
	// Indicates whether the configuration store need to be recovered.
	CreateMode *CreateMode

	// Disables all authentication methods other than AAD authentication.
	DisableLocalAuth *bool

	// Property specifying whether protection against purge is enabled for this configuration store.
	EnablePurgeProtection *bool

	// The encryption settings of the configuration store.
	Encryption *EncryptionProperties

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

	// The amount of time in days that the configuration store will be retained when it is soft deleted.
	SoftDeleteRetentionInDays *int32

	// READ-ONLY; The creation date of configuration store.
	CreationDate *time.Time

	// READ-ONLY; The DNS endpoint where the configuration store API will be available.
	Endpoint *string

	// READ-ONLY; The list of private endpoint connections that are set up for this resource.
	PrivateEndpointConnections []*PrivateEndpointConnectionReference

	// READ-ONLY; The provisioning state of the configuration store.
	ProvisioningState *ProvisioningState
}

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

	// Property specifying whether protection against purge is enabled for this configuration store.
	EnablePurgeProtection *bool

	// The encryption settings of the configuration store.
	Encryption *EncryptionProperties

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

ConfigurationStorePropertiesUpdateParameters - The properties for updating a configuration store.

func (ConfigurationStorePropertiesUpdateParameters) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ConfigurationStorePropertiesUpdateParameters.

func (*ConfigurationStorePropertiesUpdateParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationStorePropertiesUpdateParameters.

type ConfigurationStoreUpdateParameters

type ConfigurationStoreUpdateParameters struct {
	// The managed identity information for the configuration store.
	Identity *ResourceIdentity

	// The properties for updating a configuration store.
	Properties *ConfigurationStorePropertiesUpdateParameters

	// The SKU of the configuration store.
	SKU *SKU

	// The ARM resource tags.
	Tags map[string]*string
}

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.

func (*ConfigurationStoreUpdateParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[ConfigurationStoresClientCreateResponse], error)

BeginCreate - Creates a configuration store with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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 (ConfigurationStoresCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginCreate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStore{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"myTag": to.Ptr("myTagValue"),
	},
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"myTag": to.Ptr("myTagValue"),
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(false),
// 		EnablePurgeProtection: to.Ptr(false),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 		SoftDeleteRetentionInDays: to.Ptr[int32](30),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

Example (ConfigurationStoresCreateWithIdentity)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresCreateWithIdentity.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginCreate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStore{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"myTag": to.Ptr("myTagValue"),
	},
	Identity: &armappconfiguration.ResourceIdentity{
		Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
			"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {},
		},
	},
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"myTag": to.Ptr("myTagValue"),
// 	},
// 	Identity: &armappconfiguration.ResourceIdentity{
// 		Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"),
// 		TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
// 		UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
// 			"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": &armappconfiguration.UserIdentity{
// 				ClientID: to.Ptr("CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC"),
// 				PrincipalID: to.Ptr("DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"),
// 			},
// 		},
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(false),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

Example (ConfigurationStoresCreateWithLocalAuthDisabled)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresCreateWithLocalAuthDisabled.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginCreate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStore{
	Location: to.Ptr("westus"),
	Properties: &armappconfiguration.ConfigurationStoreProperties{
		DisableLocalAuth: to.Ptr(true),
	},
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(true),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

func (*ConfigurationStoresClient) BeginDelete

BeginDelete - Deletes a configuration store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginDelete(ctx, "myResourceGroup", "contoso", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConfigurationStoresClient) BeginPurgeDeleted

BeginPurgeDeleted - Permanently deletes the specified configuration store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • location - The location in which uniqueness will be verified.
  • configStoreName - The name of the configuration store.
  • options - ConfigurationStoresClientBeginPurgeDeletedOptions contains the optional parameters for the ConfigurationStoresClient.BeginPurgeDeleted method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/DeletedConfigurationStoresPurge.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginPurgeDeleted(ctx, "westus", "contoso", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConfigurationStoresClient) BeginUpdate

func (client *ConfigurationStoresClient) BeginUpdate(ctx context.Context, resourceGroupName string, configStoreName string, configStoreUpdateParameters ConfigurationStoreUpdateParameters, options *ConfigurationStoresClientBeginUpdateOptions) (*runtime.Poller[ConfigurationStoresClientUpdateResponse], error)

BeginUpdate - Updates a configuration store with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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 (ConfigurationStoresUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
	Tags: map[string]*string{
		"Category": to.Ptr("Marketing"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Category": to.Ptr("Marketing"),
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(false),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

Example (ConfigurationStoresUpdateDisableLocalAuth)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
	Properties: &armappconfiguration.ConfigurationStorePropertiesUpdateParameters{
		DisableLocalAuth: to.Ptr(true),
	},
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(true),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

Example (ConfigurationStoresUpdateWithIdentity)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
	Identity: &armappconfiguration.ResourceIdentity{
		Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
		UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
			"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {},
		},
	},
	SKU: &armappconfiguration.SKU{
		Name: to.Ptr("Standard"),
	},
	Tags: map[string]*string{
		"Category": to.Ptr("Marketing"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Category": to.Ptr("Marketing"),
// 	},
// 	Identity: &armappconfiguration.ResourceIdentity{
// 		Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"),
// 		TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
// 		UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
// 			"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": &armappconfiguration.UserIdentity{
// 				ClientID: to.Ptr("CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC"),
// 				PrincipalID: to.Ptr("DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"),
// 			},
// 		},
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(false),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

func (*ConfigurationStoresClient) Get

Get - Gets the properties of the specified configuration store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationStoresClient().Get(ctx, "myResourceGroup", "contoso", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armappconfiguration.ResourceIdentity{
// 		Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"),
// 		TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
// 	},
// 	Properties: &armappconfiguration.ConfigurationStoreProperties{
// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		DisableLocalAuth: to.Ptr(false),
// 		Encryption: &armappconfiguration.EncryptionProperties{
// 			KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// 			},
// 		},
// 		Endpoint: to.Ptr("https://contoso.azconfig.io"),
// 		PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// 	},
// 	SKU: &armappconfiguration.SKU{
// 		Name: to.Ptr("Standard"),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

func (*ConfigurationStoresClient) GetDeleted

GetDeleted - Gets a deleted Azure app configuration store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • location - The location in which uniqueness will be verified.
  • configStoreName - The name of the configuration store.
  • options - ConfigurationStoresClientGetDeletedOptions contains the optional parameters for the ConfigurationStoresClient.GetDeleted method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/DeletedConfigurationStoresGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationStoresClient().GetDeleted(ctx, "westus", "contoso", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeletedConfigurationStore = armappconfiguration.DeletedConfigurationStore{
// 	Name: to.Ptr("contoso"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/deletedConfigurationStores"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.AppConfiguration/locations/westus/deletedConfigurationStores/contoso"),
// 	Properties: &armappconfiguration.DeletedConfigurationStoreProperties{
// 		ConfigurationStoreID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// 		DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-01T00:00:59.000Z"); return t}()),
// 		Location: to.Ptr("westus"),
// 		PurgeProtectionEnabled: to.Ptr(true),
// 		ScheduledPurgeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-01T00:00:59.000Z"); return t}()),
// 		Tags: map[string]*string{
// 		},
// 	},
// }
Output:

func (*ConfigurationStoresClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists the configuration stores for a given resource group.

Generated from API version 2023-03-01

  • resourceGroupName - The name of the resource group to which the container registry belongs.
  • options - ConfigurationStoresClientListByResourceGroupOptions contains the optional parameters for the ConfigurationStoresClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationStoresClient().NewListByResourceGroupPager("myResourceGroup", &armappconfiguration.ConfigurationStoresClientListByResourceGroupOptions{SkipToken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ConfigurationStoreListResult = armappconfiguration.ConfigurationStoreListResult{
	// 	Value: []*armappconfiguration.ConfigurationStore{
	// 		{
	// 			Name: to.Ptr("contoso"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armappconfiguration.ConfigurationStoreProperties{
	// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				DisableLocalAuth: to.Ptr(false),
	// 				Encryption: &armappconfiguration.EncryptionProperties{
	// 					KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
	// 					},
	// 				},
	// 				Endpoint: to.Ptr("https://contoso.azconfig.io"),
	// 				PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
	// 				},
	// 				ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
	// 			},
	// 			SKU: &armappconfiguration.SKU{
	// 				Name: to.Ptr("Standard"),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("contoso2"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso2"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Properties: &armappconfiguration.ConfigurationStoreProperties{
	// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T23:06:59.000Z"); return t}()),
	// 				DisableLocalAuth: to.Ptr(false),
	// 				Encryption: &armappconfiguration.EncryptionProperties{
	// 					KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
	// 					},
	// 				},
	// 				Endpoint: to.Ptr("https://contoso2.azconfig.io"),
	// 				PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
	// 				},
	// 				ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
	// 			},
	// 			SKU: &armappconfiguration.SKU{
	// 				Name: to.Ptr("Standard"),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 	}},
	// }
}
Output:

func (*ConfigurationStoresClient) NewListDeletedPager

NewListDeletedPager - Gets information about the deleted configuration stores in a subscription.

Generated from API version 2023-03-01

  • options - ConfigurationStoresClientListDeletedOptions contains the optional parameters for the ConfigurationStoresClient.NewListDeletedPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/DeletedConfigurationStoresList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationStoresClient().NewListDeletedPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DeletedConfigurationStoreListResult = armappconfiguration.DeletedConfigurationStoreListResult{
	// 	Value: []*armappconfiguration.DeletedConfigurationStore{
	// 		{
	// 			Name: to.Ptr("contoso"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/deletedConfigurationStores"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.AppConfiguration/locations/westus/deletedConfigurationStores/contoso"),
	// 			Properties: &armappconfiguration.DeletedConfigurationStoreProperties{
	// 				ConfigurationStoreID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
	// 				DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-01T00:00:59.000Z"); return t}()),
	// 				Location: to.Ptr("westus"),
	// 				PurgeProtectionEnabled: to.Ptr(true),
	// 				ScheduledPurgeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-01T00:00:59.000Z"); return t}()),
	// 				Tags: map[string]*string{
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

func (*ConfigurationStoresClient) NewListKeysPager

func (client *ConfigurationStoresClient) NewListKeysPager(resourceGroupName string, configStoreName string, options *ConfigurationStoresClientListKeysOptions) *runtime.Pager[ConfigurationStoresClientListKeysResponse]

NewListKeysPager - Lists the access key for the specified configuration store.

Generated from API version 2023-03-01

  • 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.NewListKeysPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationStoresClient().NewListKeysPager("myResourceGroup", "contoso", &armappconfiguration.ConfigurationStoresClientListKeysOptions{SkipToken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.APIKeyListResult = armappconfiguration.APIKeyListResult{
	// 	Value: []*armappconfiguration.APIKey{
	// 		{
	// 			Name: to.Ptr("Primary"),
	// 			ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
	// 			ID: to.Ptr("439AD01B4BE67DB1"),
	// 			LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
	// 			ReadOnly: to.Ptr(false),
	// 			Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Secondary"),
	// 			ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
	// 			ID: to.Ptr("CB45E100456857B9"),
	// 			LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
	// 			ReadOnly: to.Ptr(false),
	// 			Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Primary Read Only"),
	// 			ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
	// 			ID: to.Ptr("B3AC55B7E71431A9"),
	// 			LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
	// 			ReadOnly: to.Ptr(true),
	// 			Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Secondary Read Only"),
	// 			ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
	// 			ID: to.Ptr("E2AF6A9A89DCC177"),
	// 			LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:54.000Z"); return t}()),
	// 			ReadOnly: to.Ptr(true),
	// 			Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
	// 	}},
	// }
}
Output:

func (*ConfigurationStoresClient) NewListPager

NewListPager - Lists the configuration stores for a given subscription.

Generated from API version 2023-03-01

  • options - ConfigurationStoresClientListOptions contains the optional parameters for the ConfigurationStoresClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationStoresClient().NewListPager(&armappconfiguration.ConfigurationStoresClientListOptions{SkipToken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ConfigurationStoreListResult = armappconfiguration.ConfigurationStoreListResult{
	// 	Value: []*armappconfiguration.ConfigurationStore{
	// 		{
	// 			Name: to.Ptr("contoso"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armappconfiguration.ResourceIdentity{
	// 				Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"),
	// 				TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
	// 			},
	// 			Properties: &armappconfiguration.ConfigurationStoreProperties{
	// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				DisableLocalAuth: to.Ptr(false),
	// 				Encryption: &armappconfiguration.EncryptionProperties{
	// 					KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
	// 					},
	// 				},
	// 				Endpoint: to.Ptr("https://contoso.azconfig.io"),
	// 				PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
	// 				},
	// 				ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
	// 			},
	// 			SKU: &armappconfiguration.SKU{
	// 				Name: to.Ptr("Standard"),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("contoso2"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso2"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armappconfiguration.ResourceIdentity{
	// 				Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC"),
	// 				TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
	// 			},
	// 			Properties: &armappconfiguration.ConfigurationStoreProperties{
	// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T23:06:59.000Z"); return t}()),
	// 				DisableLocalAuth: to.Ptr(false),
	// 				Encryption: &armappconfiguration.EncryptionProperties{
	// 					KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
	// 					},
	// 				},
	// 				Endpoint: to.Ptr("https://contoso2.azconfig.io"),
	// 				PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
	// 				},
	// 				ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
	// 			},
	// 			SKU: &armappconfiguration.SKU{
	// 				Name: to.Ptr("Standard"),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 	}},
	// }
}
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.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresRegenerateKey.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationStoresClient().RegenerateKey(ctx, "myResourceGroup", "contoso", armappconfiguration.RegenerateKeyParameters{
	ID: to.Ptr("439AD01B4BE67DB1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.APIKey = armappconfiguration.APIKey{
// 	Name: to.Ptr("Primary"),
// 	ConnectionString: to.Ptr("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
// 	ID: to.Ptr("439AD01B4BE67DB1"),
// 	LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-26T22:59:24.237Z"); return t}()),
// 	ReadOnly: to.Ptr(false),
// 	Value: to.Ptr("000000000000000000000000000000000000000000000000000000"),
// }
Output:

type ConfigurationStoresClientBeginCreateOptions

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

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

type ConfigurationStoresClientBeginDeleteOptions

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

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

type ConfigurationStoresClientBeginPurgeDeletedOptions

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

ConfigurationStoresClientBeginPurgeDeletedOptions contains the optional parameters for the ConfigurationStoresClient.BeginPurgeDeleted method.

type ConfigurationStoresClientBeginUpdateOptions

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

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

type ConfigurationStoresClientCreateResponse

type ConfigurationStoresClientCreateResponse struct {
	// The configuration store along with all resource properties. The Configuration Store will have all information to begin
	// utilizing it.
	ConfigurationStore
}

ConfigurationStoresClientCreateResponse contains the response from method ConfigurationStoresClient.BeginCreate.

type ConfigurationStoresClientDeleteResponse

type ConfigurationStoresClientDeleteResponse struct {
}

ConfigurationStoresClientDeleteResponse contains the response from method ConfigurationStoresClient.BeginDelete.

type ConfigurationStoresClientGetDeletedOptions

type ConfigurationStoresClientGetDeletedOptions struct {
}

ConfigurationStoresClientGetDeletedOptions contains the optional parameters for the ConfigurationStoresClient.GetDeleted method.

type ConfigurationStoresClientGetDeletedResponse

type ConfigurationStoresClientGetDeletedResponse struct {
	// Deleted configuration store information with extended details.
	DeletedConfigurationStore
}

ConfigurationStoresClientGetDeletedResponse contains the response from method ConfigurationStoresClient.GetDeleted.

type ConfigurationStoresClientGetOptions

type ConfigurationStoresClientGetOptions struct {
}

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

type ConfigurationStoresClientGetResponse

type ConfigurationStoresClientGetResponse struct {
	// The configuration store along with all resource properties. The Configuration Store will have all information to begin
	// utilizing it.
	ConfigurationStore
}

ConfigurationStoresClientGetResponse contains the response from method ConfigurationStoresClient.Get.

type ConfigurationStoresClientListByResourceGroupOptions

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.NewListByResourceGroupPager method.

type ConfigurationStoresClientListByResourceGroupResponse

type ConfigurationStoresClientListByResourceGroupResponse struct {
	// The result of a request to list configuration stores.
	ConfigurationStoreListResult
}

ConfigurationStoresClientListByResourceGroupResponse contains the response from method ConfigurationStoresClient.NewListByResourceGroupPager.

type ConfigurationStoresClientListDeletedOptions

type ConfigurationStoresClientListDeletedOptions struct {
}

ConfigurationStoresClientListDeletedOptions contains the optional parameters for the ConfigurationStoresClient.NewListDeletedPager method.

type ConfigurationStoresClientListDeletedResponse

type ConfigurationStoresClientListDeletedResponse struct {
	// List of deleted configuration stores
	DeletedConfigurationStoreListResult
}

ConfigurationStoresClientListDeletedResponse contains the response from method ConfigurationStoresClient.NewListDeletedPager.

type ConfigurationStoresClientListKeysOptions

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.NewListKeysPager method.

type ConfigurationStoresClientListKeysResponse

type ConfigurationStoresClientListKeysResponse struct {
	// The result of a request to list API keys.
	APIKeyListResult
}

ConfigurationStoresClientListKeysResponse contains the response from method ConfigurationStoresClient.NewListKeysPager.

type ConfigurationStoresClientListOptions

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.NewListPager method.

type ConfigurationStoresClientListResponse

type ConfigurationStoresClientListResponse struct {
	// The result of a request to list configuration stores.
	ConfigurationStoreListResult
}

ConfigurationStoresClientListResponse contains the response from method ConfigurationStoresClient.NewListPager.

type ConfigurationStoresClientPurgeDeletedResponse

type ConfigurationStoresClientPurgeDeletedResponse struct {
}

ConfigurationStoresClientPurgeDeletedResponse contains the response from method ConfigurationStoresClient.BeginPurgeDeleted.

type ConfigurationStoresClientRegenerateKeyOptions

type ConfigurationStoresClientRegenerateKeyOptions struct {
}

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

type ConfigurationStoresClientRegenerateKeyResponse

type ConfigurationStoresClientRegenerateKeyResponse struct {
	// An API key used for authenticating with a configuration store endpoint.
	APIKey
}

ConfigurationStoresClientRegenerateKeyResponse contains the response from method ConfigurationStoresClient.RegenerateKey.

type ConfigurationStoresClientUpdateResponse

type ConfigurationStoresClientUpdateResponse struct {
	// The configuration store along with all resource properties. The Configuration Store will have all information to begin
	// utilizing it.
	ConfigurationStore
}

ConfigurationStoresClientUpdateResponse contains the response from method ConfigurationStoresClient.BeginUpdate.

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.

type CreateMode

type CreateMode string

CreateMode - Indicates whether the configuration store need to be recovered.

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

func PossibleCreateModeValues

func PossibleCreateModeValues() []CreateMode

PossibleCreateModeValues returns the possible values for the CreateMode const type.

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.

type DeletedConfigurationStore

type DeletedConfigurationStore struct {
	// Properties of the deleted configuration store
	Properties *DeletedConfigurationStoreProperties

	// READ-ONLY; The resource ID for the deleted configuration store.
	ID *string

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

	// READ-ONLY; The resource type of the configuration store.
	Type *string
}

DeletedConfigurationStore - Deleted configuration store information with extended details.

func (DeletedConfigurationStore) MarshalJSON

func (d DeletedConfigurationStore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedConfigurationStore.

func (*DeletedConfigurationStore) UnmarshalJSON

func (d *DeletedConfigurationStore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedConfigurationStore.

type DeletedConfigurationStoreListResult

type DeletedConfigurationStoreListResult struct {
	// The URL to get the next set of deleted configuration stores.
	NextLink *string

	// The list of deleted configuration store.
	Value []*DeletedConfigurationStore
}

DeletedConfigurationStoreListResult - List of deleted configuration stores

func (DeletedConfigurationStoreListResult) MarshalJSON

func (d DeletedConfigurationStoreListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedConfigurationStoreListResult.

func (*DeletedConfigurationStoreListResult) UnmarshalJSON

func (d *DeletedConfigurationStoreListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedConfigurationStoreListResult.

type DeletedConfigurationStoreProperties

type DeletedConfigurationStoreProperties struct {
	// READ-ONLY; The resource id of the original configuration store.
	ConfigurationStoreID *string

	// READ-ONLY; The deleted date.
	DeletionDate *time.Time

	// READ-ONLY; The location of the original configuration store.
	Location *string

	// READ-ONLY; Purge protection status of the original configuration store.
	PurgeProtectionEnabled *bool

	// READ-ONLY; The scheduled purged date.
	ScheduledPurgeDate *time.Time

	// READ-ONLY; Tags of the original configuration store.
	Tags map[string]*string
}

DeletedConfigurationStoreProperties - Properties of the deleted configuration store.

func (DeletedConfigurationStoreProperties) MarshalJSON

func (d DeletedConfigurationStoreProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedConfigurationStoreProperties.

func (*DeletedConfigurationStoreProperties) UnmarshalJSON

func (d *DeletedConfigurationStoreProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedConfigurationStoreProperties.

type EncryptionProperties

type EncryptionProperties struct {
	// Key vault properties.
	KeyVaultProperties *KeyVaultProperties
}

EncryptionProperties - The encryption settings for a configuration store.

func (EncryptionProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EncryptionProperties.

func (*EncryptionProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionProperties.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetails

type ErrorDetails struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; Error code.
	Code *string

	// READ-ONLY; Error message indicating why the operation failed.
	Message *string
}

ErrorDetails - The details of the error.

func (ErrorDetails) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetails.

func (*ErrorDetails) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetails.

type ErrorResponse

type ErrorResponse struct {
	// The details of the error.
	Error *ErrorDetails
}

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

func (ErrorResponse) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

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.

type KeyValue

type KeyValue struct {
	// All key-value properties.
	Properties *KeyValueProperties

	// READ-ONLY; The resource ID.
	ID *string

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

	// READ-ONLY; The type of the resource.
	Type *string
}

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

func (KeyValue) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type KeyValue.

func (*KeyValue) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type KeyValue.

type KeyValueListResult

type KeyValueListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string

	// The collection value.
	Value []*KeyValue
}

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.

func (*KeyValueListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

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

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

	// READ-ONLY; An ETag indicating the state of a key-value within a configuration store.
	ETag *string

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

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

	// READ-ONLY; The last time a modifying operation was performed on the given key-value.
	LastModified *time.Time

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

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, error)

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) (*runtime.Poller[KeyValuesClientDeleteResponse], error)

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

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresDeleteKeyValue.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewKeyValuesClient().BeginDelete(ctx, "myResourceGroup", "contoso", "myKey$myLabel", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresCreateKeyValue.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewKeyValuesClient().CreateOrUpdate(ctx, "myResourceGroup", "contoso", "myKey$myLabel", &armappconfiguration.KeyValuesClientCreateOrUpdateOptions{KeyValueParameters: &armappconfiguration.KeyValue{
	Properties: &armappconfiguration.KeyValueProperties{
		Tags: map[string]*string{
			"tag1": to.Ptr("tagValue1"),
			"tag2": to.Ptr("tagValue2"),
		},
		Value: to.Ptr("myValue"),
	},
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.KeyValue = armappconfiguration.KeyValue{
// 	Name: to.Ptr("myKey$myLabel"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/keyValues/myKey$myLabel"),
// 	Properties: &armappconfiguration.KeyValueProperties{
// 		ContentType: to.Ptr(""),
// 		ETag: to.Ptr("IhDxoa8VkXxPsYsemBlxvV0d5fp"),
// 		Key: to.Ptr("myKey"),
// 		Label: to.Ptr("myLabel"),
// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:42:24.000Z"); return t}()),
// 		Locked: to.Ptr(false),
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("tagValue1"),
// 			"tag2": to.Ptr("tagValue2"),
// 		},
// 		Value: to.Ptr("myValue"),
// 	},
// }
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.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresGetKeyValue.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewKeyValuesClient().Get(ctx, "myResourceGroup", "contoso", "myKey$myLabel", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.KeyValue = armappconfiguration.KeyValue{
// 	Name: to.Ptr("myKey$myLabel"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/keyValues/myKey$myLabel"),
// 	Properties: &armappconfiguration.KeyValueProperties{
// 		ContentType: to.Ptr(""),
// 		ETag: to.Ptr("IhDxoa8VkXxPsYsemBlxvV0d5fp"),
// 		Key: to.Ptr("myKey"),
// 		Label: to.Ptr("myLabel"),
// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:42:24.000Z"); return t}()),
// 		Locked: to.Ptr(false),
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("tagValue1"),
// 			"tag2": to.Ptr("tagValue2"),
// 		},
// 		Value: to.Ptr("myValue"),
// 	},
// }
Output:

type KeyValuesClientBeginDeleteOptions

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

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

type KeyValuesClientCreateOrUpdateOptions

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

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

type KeyValuesClientCreateOrUpdateResponse

type KeyValuesClientCreateOrUpdateResponse struct {
	// The key-value resource along with all resource properties.
	KeyValue
}

KeyValuesClientCreateOrUpdateResponse contains the response from method KeyValuesClient.CreateOrUpdate.

type KeyValuesClientDeleteResponse

type KeyValuesClientDeleteResponse struct {
}

KeyValuesClientDeleteResponse contains the response from method KeyValuesClient.BeginDelete.

type KeyValuesClientGetOptions

type KeyValuesClientGetOptions struct {
}

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

type KeyValuesClientGetResponse

type KeyValuesClientGetResponse struct {
	// The key-value resource along with all resource properties.
	KeyValue
}

KeyValuesClientGetResponse contains the response from method KeyValuesClient.Get.

type KeyVaultProperties

type KeyVaultProperties struct {
	// The client id of the identity which will be used to access key vault.
	IdentityClientID *string

	// The URI of the key vault key used to encrypt data.
	KeyIdentifier *string
}

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

func (KeyVaultProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type KeyVaultProperties.

func (*KeyVaultProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultProperties.

type LogSpecification

type LogSpecification struct {
	// Blob duration of the log
	BlobDuration *string

	// Localized friendly display name of the log
	DisplayName *string

	// Name of the log
	Name *string
}

LogSpecification - Specifications of the Log for Azure Monitoring

func (LogSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type LogSpecification.

func (*LogSpecification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type LogSpecification.

type MetricDimension

type MetricDimension struct {
	// Localized friendly display name of the dimension
	DisplayName *string

	// Internal name of the dimension.
	InternalName *string

	// Name of the dimension
	Name *string
}

MetricDimension - Specifications of the Dimension of metrics

func (MetricDimension) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type MetricDimension.

func (*MetricDimension) UnmarshalJSON

func (m *MetricDimension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetricDimension.

type MetricSpecification

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

	// Dimensions of the metric
	Dimensions []*MetricDimension

	// Localized friendly description of the metric
	DisplayDescription *string

	// Localized friendly display name of the metric
	DisplayName *string

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

	// Internal metric name.
	InternalMetricName *string

	// Name of the metric
	Name *string

	// Unit that makes sense for the metric
	Unit *string
}

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.

func (*MetricSpecification) UnmarshalJSON

func (m *MetricSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// READ-ONLY; The value indicating whether the resource name is available.
	NameAvailable *bool

	// READ-ONLY; If any, the reason that the name is not available.
	Reason *string
}

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

func (NameAvailabilityStatus) MarshalJSON

func (n NameAvailabilityStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NameAvailabilityStatus.

func (*NameAvailabilityStatus) UnmarshalJSON

func (n *NameAvailabilityStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NameAvailabilityStatus.

type OperationDefinition

type OperationDefinition struct {
	// The display information for the configuration store operation.
	Display *OperationDefinitionDisplay

	// Indicates whether the operation is a data action
	IsDataAction *bool

	// Operation name: {provider}/{resource}/{operation}.
	Name *string

	// Origin of the operation
	Origin *string

	// Properties of the operation
	Properties *OperationProperties
}

OperationDefinition - The definition of a configuration store operation.

func (OperationDefinition) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationDefinition.

func (*OperationDefinition) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDefinition.

type OperationDefinitionDisplay

type OperationDefinitionDisplay struct {
	// The description for the operation.
	Description *string

	// The operation that users can perform.
	Operation *string

	// The resource on which the operation is performed.
	Resource *string

	// READ-ONLY; The resource provider name: Microsoft App Configuration."
	Provider *string
}

OperationDefinitionDisplay - The display information for a configuration store operation.

func (OperationDefinitionDisplay) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationDefinitionDisplay.

func (*OperationDefinitionDisplay) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDefinitionDisplay.

type OperationDefinitionListResult

type OperationDefinitionListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string

	// The collection value.
	Value []*OperationDefinition
}

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.

func (*OperationDefinitionListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDefinitionListResult.

type OperationProperties

type OperationProperties struct {
	// Service specifications of the operation
	ServiceSpecification *ServiceSpecification
}

OperationProperties - Extra Operation properties

func (OperationProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

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, error)

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

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

Generated from API version 2023-03-01

  • checkNameAvailabilityParameters - The object containing information for the availability request.
  • options - OperationsClientCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.CheckNameAvailability method.
Example (ConfigurationStoresCheckNameAvailable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/CheckNameAvailable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsClient().CheckNameAvailability(ctx, armappconfiguration.CheckNameAvailabilityParameters{
	Name: to.Ptr("contoso"),
	Type: to.Ptr(armappconfiguration.ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NameAvailabilityStatus = armappconfiguration.NameAvailabilityStatus{
// 	Message: to.Ptr("The specified name is available."),
// 	NameAvailable: to.Ptr(true),
// }
Output:

Example (ConfigurationStoresCheckNameNotAvailable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/CheckNameNotAvailable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsClient().CheckNameAvailability(ctx, armappconfiguration.CheckNameAvailabilityParameters{
	Name: to.Ptr("contoso"),
	Type: to.Ptr(armappconfiguration.ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NameAvailabilityStatus = armappconfiguration.NameAvailabilityStatus{
// 	Message: to.Ptr("The specified name is already in use."),
// 	NameAvailable: to.Ptr(false),
// 	Reason: to.Ptr("AlreadyExists"),
// }
Output:

func (*OperationsClient) NewListPager

NewListPager - Lists the operations available from this provider.

Generated from API version 2023-03-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/OperationsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(&armappconfiguration.OperationsClientListOptions{SkipToken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OperationDefinitionListResult = armappconfiguration.OperationDefinitionListResult{
	// 	Value: []*armappconfiguration.OperationDefinition{
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/operations/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Lists all of the operations supported by Microsoft App Configuration."),
	// 				Operation: to.Ptr("List Operations"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Operation"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/register/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Registers a subscription to use Microsoft App Configuration."),
	// 				Operation: to.Ptr("Register for Microsoft App Configuration"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Microsoft App Configuration"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/unregister/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Unregisters a subscription from using Microsoft App Configuration."),
	// 				Operation: to.Ptr("Unregister for Microsoft App Configuration"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Microsoft App Configuration"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/locations/operationsStatus/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Get the status of an operation."),
	// 				Operation: to.Ptr("Get Operation Status"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/checkNameAvailability/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Check whether the resource name is available for use."),
	// 				Operation: to.Ptr("Check Name Availability"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/locations/checkNameAvailability/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Check whether the resource name is available for use."),
	// 				Operation: to.Ptr("Check Name Availability"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Gets the properties of the specified configuration store or lists all the configuration stores under the specified resource group or subscription."),
	// 				Operation: to.Ptr("Get Configuration Store or List Configuration Stores"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Create or update a configuration store with the specified parameters."),
	// 				Operation: to.Ptr("Create or Update Configuration Store"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/delete"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Deletes a configuration store."),
	// 				Operation: to.Ptr("Delete Configuration Store"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/ListKeys/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Lists the API keys for the specified configuration store."),
	// 				Operation: to.Ptr("List Configuration Store API Keys"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/RegenerateKey/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Regenerates of the API key's for the specified configuration store."),
	// 				Operation: to.Ptr("Regenerate Configuration Store API Key"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/ListKeyValue/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Lists a key-value for the specified configuration store."),
	// 				Operation: to.Ptr("List Configuration Store Key-Value"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/eventGridFilters/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Gets the properties of the specified configuration store event grid filter or lists all the configuration store event grid filters under the specified configuration store."),
	// 				Operation: to.Ptr("Get Configuration Store Event Grid Filter or List Configuration Store Event Grid Filters"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store Event Grid Filter"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/eventGridFilters/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Create or update a configuration store event grid filter with the specified parameters."),
	// 				Operation: to.Ptr("Create or Update Configuration Store Event Grid Filter"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store Event Grid Filter"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/eventGridFilters/delete"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Deletes a configuration store event grid filter."),
	// 				Operation: to.Ptr("Delete Configuration Store Event Grid Filter"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store Event Grid Filter"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/providers/Microsoft.Insights/metricDefinitions/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Retrieve all metric definitions for Microsoft App Configuration."),
	// 				Operation: to.Ptr("Read Configuration Store Metric Definitions"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Microsoft App Configuration Metric Definition."),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr("System"),
	// 			Properties: &armappconfiguration.OperationProperties{
	// 				ServiceSpecification: &armappconfiguration.ServiceSpecification{
	// 					MetricSpecifications: []*armappconfiguration.MetricSpecification{
	// 						{
	// 							Name: to.Ptr("HttpIncomingRequestCount"),
	// 							AggregationType: to.Ptr("Count"),
	// 							Dimensions: []*armappconfiguration.MetricDimension{
	// 								{
	// 									Name: to.Ptr("StatusCode"),
	// 									DisplayName: to.Ptr("HttpStatusCode"),
	// 									InternalName: to.Ptr("StatusCode"),
	// 								},
	// 								{
	// 									Name: to.Ptr("Authentication"),
	// 									DisplayName: to.Ptr("AuthenticationScheme"),
	// 									InternalName: to.Ptr("Authentication"),
	// 							}},
	// 							DisplayDescription: to.Ptr("Total number of incoming http requests."),
	// 							DisplayName: to.Ptr("HttpIncomingRequestCount"),
	// 							FillGapWithZero: to.Ptr(true),
	// 							InternalMetricName: to.Ptr("HttpIncomingRequestCount"),
	// 							Unit: to.Ptr("Count"),
	// 						},
	// 						{
	// 							Name: to.Ptr("HttpIncomingRequestDuration"),
	// 							AggregationType: to.Ptr("Average"),
	// 							Dimensions: []*armappconfiguration.MetricDimension{
	// 								{
	// 									Name: to.Ptr("StatusCode"),
	// 									DisplayName: to.Ptr("HttpStatusCode"),
	// 									InternalName: to.Ptr("StatusCode"),
	// 								},
	// 								{
	// 									Name: to.Ptr("Authentication"),
	// 									DisplayName: to.Ptr("AuthenticationScheme"),
	// 									InternalName: to.Ptr("Authentication"),
	// 							}},
	// 							DisplayDescription: to.Ptr("Latency on an http request."),
	// 							DisplayName: to.Ptr("HttpIncomingRequestDuration"),
	// 							FillGapWithZero: to.Ptr(true),
	// 							InternalMetricName: to.Ptr("HttpIncomingRequestDuration"),
	// 							Unit: to.Ptr("Count"),
	// 						},
	// 						{
	// 							Name: to.Ptr("ThrottledHttpRequestCount"),
	// 							AggregationType: to.Ptr("Count"),
	// 							DisplayDescription: to.Ptr("Throttled http requests."),
	// 							DisplayName: to.Ptr("ThrottledHttpRequestCount"),
	// 							FillGapWithZero: to.Ptr(true),
	// 							InternalMetricName: to.Ptr("ThrottledHttpRequestCount"),
	// 							Unit: to.Ptr("Count"),
	// 					}},
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/providers/Microsoft.Insights/diagnosticSettings/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Read all Diagnostic Settings values for a Configuration Store."),
	// 				Operation: to.Ptr("Read Configuration Store Diagnostic Settings"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr("System"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/providers/Microsoft.Insights/diagnosticSettings/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Write/Overwrite Diagnostic Settings for Microsoft App Configuration."),
	// 				Operation: to.Ptr("Write Configuration Store Diagnostic Settings"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr("System"),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/providers/Microsoft.Insights/logDefinitions/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Retrieve all log definitions for Microsoft App Configuration."),
	// 				Operation: to.Ptr("Read Configuration Store Log Definitions"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Microsoft App Configuration Log Definition."),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Properties: &armappconfiguration.OperationProperties{
	// 				ServiceSpecification: &armappconfiguration.ServiceSpecification{
	// 					LogSpecifications: []*armappconfiguration.LogSpecification{
	// 						{
	// 							Name: to.Ptr("HttpRequest"),
	// 							DisplayName: to.Ptr("HTTP Requests"),
	// 						},
	// 						{
	// 							Name: to.Ptr("Audit"),
	// 							DisplayName: to.Ptr("Audit"),
	// 					}},
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnectionProxies/validate/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Validate a private endpoint connection proxy under the specified configuration store."),
	// 				Operation: to.Ptr("Validate Private Endpoint Connection Proxy"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnectionProxies/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Get a private endpoint connection proxy under the specified configuration store."),
	// 				Operation: to.Ptr("Get Private Endpoint Connection Proxy"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnectionProxies/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Create or update a private endpoint connection proxy under the specified configuration store."),
	// 				Operation: to.Ptr("Create or Update Private Endpoint Connection Proxy"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnectionProxies/delete"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Delete a private endpoint connection proxy under the specified configuration store."),
	// 				Operation: to.Ptr("Delete Private Endpoint Connection Proxy"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Get a private endpoint connection or list private endpoint connections under the specified configuration store."),
	// 				Operation: to.Ptr("Get Private Endpoint Connection or List Private Endpoint Connections"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Approve or reject a private endpoint connection under the specified configuration store."),
	// 				Operation: to.Ptr("Approve or Reject Private Endpoint Connection"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections/delete"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Delete a private endpoint connection under the specified configuration store."),
	// 				Operation: to.Ptr("Delete Private Endpoint Connection"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/PrivateEndpointConnectionsApproval/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Auto-Approve a private endpoint connection under the specified configuration store."),
	// 				Operation: to.Ptr("Auto-Approve Private Endpoint Connection"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Endpoint Connection"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateLinkResources/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Lists all the private link resources under the specified configuration store."),
	// 				Operation: to.Ptr("List Private Link"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Private Link"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Reads a key-value from the configuration store."),
	// 				Operation: to.Ptr("Read Key-Value"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Key-Value"),
	// 			},
	// 			IsDataAction: to.Ptr(true),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues/write"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Creates or updates a key-value in the configuration store."),
	// 				Operation: to.Ptr("Write Key-Value"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Key-Value"),
	// 			},
	// 			IsDataAction: to.Ptr(true),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues/delete"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Deletes an existing key-value from the configuration store."),
	// 				Operation: to.Ptr("Delete Key-Value"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Key-Value"),
	// 			},
	// 			IsDataAction: to.Ptr(true),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/locations/deletedConfigurationStores/read"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Gets the properties of the specified deleted configuration store or lists all the deleted configuration stores under the specified subscription."),
	// 				Operation: to.Ptr("Get Deleted Configuration Store or List Deleted Configuration Stores"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Deleted Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.AppConfiguration/locations/deletedConfigurationStores/purge/action"),
	// 			Display: &armappconfiguration.OperationDefinitionDisplay{
	// 				Description: to.Ptr("Purge the specified deleted configuration store."),
	// 				Operation: to.Ptr("Purge Deleted Configuration Store"),
	// 				Provider: to.Ptr("Microsoft App Configuration"),
	// 				Resource: to.Ptr("Deleted Configuration Store"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 	}},
	// }
}
Output:

func (*OperationsClient) RegionalCheckNameAvailability

RegionalCheckNameAvailability - Checks whether the configuration store name is available for use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • location - The location in which uniqueness will be verified.
  • checkNameAvailabilityParameters - The object containing information for the availability request.
  • options - OperationsClientRegionalCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.RegionalCheckNameAvailability method.
Example (ConfigurationStoresCheckNameAvailable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/RegionalCheckNameAvailable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsClient().RegionalCheckNameAvailability(ctx, "westus", armappconfiguration.CheckNameAvailabilityParameters{
	Name: to.Ptr("contoso"),
	Type: to.Ptr(armappconfiguration.ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NameAvailabilityStatus = armappconfiguration.NameAvailabilityStatus{
// 	Message: to.Ptr("The specified name is available."),
// 	NameAvailable: to.Ptr(true),
// }
Output:

Example (ConfigurationStoresCheckNameNotAvailable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/RegionalCheckNameNotAvailable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsClient().RegionalCheckNameAvailability(ctx, "westus", armappconfiguration.CheckNameAvailabilityParameters{
	Name: to.Ptr("contoso"),
	Type: to.Ptr(armappconfiguration.ConfigurationResourceTypeMicrosoftAppConfigurationConfigurationStores),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NameAvailabilityStatus = armappconfiguration.NameAvailabilityStatus{
// 	Message: to.Ptr("The specified name is already in use."),
// 	NameAvailable: to.Ptr(false),
// 	Reason: to.Ptr("AlreadyExists"),
// }
Output:

type OperationsClientCheckNameAvailabilityOptions

type OperationsClientCheckNameAvailabilityOptions struct {
}

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

type OperationsClientCheckNameAvailabilityResponse

type OperationsClientCheckNameAvailabilityResponse struct {
	// The result of a request to check the availability of a resource name.
	NameAvailabilityStatus
}

OperationsClientCheckNameAvailabilityResponse contains the response from method OperationsClient.CheckNameAvailability.

type OperationsClientListOptions

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.NewListPager method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	// The result of a request to list configuration store operations.
	OperationDefinitionListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsClientRegionalCheckNameAvailabilityOptions

type OperationsClientRegionalCheckNameAvailabilityOptions struct {
}

OperationsClientRegionalCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.RegionalCheckNameAvailability method.

type OperationsClientRegionalCheckNameAvailabilityResponse

type OperationsClientRegionalCheckNameAvailabilityResponse struct {
	// The result of a request to check the availability of a resource name.
	NameAvailabilityStatus
}

OperationsClientRegionalCheckNameAvailabilityResponse contains the response from method OperationsClient.RegionalCheckNameAvailability.

type PrivateEndpoint

type PrivateEndpoint struct {
	// The resource Id for private endpoint
	ID *string
}

PrivateEndpoint - Private endpoint which a connection belongs to.

func (PrivateEndpoint) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	// The properties of a private endpoint.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; The resource ID.
	ID *string

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

	// READ-ONLY; The type of the resource.
	Type *string
}

PrivateEndpointConnection - A private endpoint connection

func (PrivateEndpointConnection) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string

	// The collection value.
	Value []*PrivateEndpointConnection
}

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.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// The resource of private endpoint.
	PrivateEndpoint *PrivateEndpoint

	// READ-ONLY; The provisioning status of the private endpoint connection.
	ProvisioningState *ProvisioningState
}

PrivateEndpointConnectionProperties - Properties of a private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionReference

type PrivateEndpointConnectionReference struct {
	// The properties of a private endpoint connection.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; The resource ID.
	ID *string

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

	// READ-ONLY; The type of the resource.
	Type *string
}

PrivateEndpointConnectionReference - A reference to a related private endpoint connection.

func (PrivateEndpointConnectionReference) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionReference.

func (*PrivateEndpointConnectionReference) UnmarshalJSON

func (p *PrivateEndpointConnectionReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionReference.

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, error)

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) (*runtime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Update the state of the specified private endpoint connection associated with the configuration store. This operation cannot be used to create a private endpoint connection. Private endpoint connections must be created with the Network resource provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdatePrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "contoso", "myConnection", armappconfiguration.PrivateEndpointConnection{
	Properties: &armappconfiguration.PrivateEndpointConnectionProperties{
		PrivateLinkServiceConnectionState: &armappconfiguration.PrivateLinkServiceConnectionState{
			Description: to.Ptr("Auto-Approved"),
			Status:      to.Ptr(armappconfiguration.ConnectionStatusApproved),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armappconfiguration.PrivateEndpointConnection{
// 	Name: to.Ptr("myConnection"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection"),
// 	Properties: &armappconfiguration.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armappconfiguration.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"),
// 		},
// 		PrivateLinkServiceConnectionState: &armappconfiguration.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("Auto-Approved"),
// 			ActionsRequired: to.Ptr(armappconfiguration.ActionsRequiredNone),
// 			Status: to.Ptr(armappconfiguration.ConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*PrivateEndpointConnectionsClient) BeginDelete

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, configStoreName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "myResourceGroup", "contoso", "myConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresGetPrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "myResourceGroup", "contoso", "myConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armappconfiguration.PrivateEndpointConnection{
// 	Name: to.Ptr("myConnection"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection"),
// 	Properties: &armappconfiguration.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armappconfiguration.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"),
// 		},
// 		PrivateLinkServiceConnectionState: &armappconfiguration.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("Auto-Approved"),
// 			ActionsRequired: to.Ptr(armappconfiguration.ActionsRequiredNone),
// 			Status: to.Ptr(armappconfiguration.ConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*PrivateEndpointConnectionsClient) NewListByConfigurationStorePager

NewListByConfigurationStorePager - Lists all private endpoint connections for a configuration store.

Generated from API version 2023-03-01

  • 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.NewListByConfigurationStorePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListPrivateEndpointConnections.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByConfigurationStorePager("myResourceGroup", "contoso", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateEndpointConnectionListResult = armappconfiguration.PrivateEndpointConnectionListResult{
	// 	Value: []*armappconfiguration.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("myConnection"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection"),
	// 			Properties: &armappconfiguration.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armappconfiguration.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armappconfiguration.PrivateLinkServiceConnectionState{
	// 					Description: to.Ptr("Auto-Approved"),
	// 					ActionsRequired: to.Ptr(armappconfiguration.ActionsRequiredNone),
	// 					Status: to.Ptr(armappconfiguration.ConnectionStatusApproved),
	// 				},
	// 				ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}
Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions

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

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

type PrivateEndpointConnectionsClientBeginDeleteOptions

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

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

type PrivateEndpointConnectionsClientCreateOrUpdateResponse

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.BeginCreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteResponse

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions

type PrivateEndpointConnectionsClientGetOptions struct {
}

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

type PrivateEndpointConnectionsClientGetResponse

type PrivateEndpointConnectionsClientGetResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByConfigurationStoreOptions

type PrivateEndpointConnectionsClientListByConfigurationStoreOptions struct {
}

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

type PrivateEndpointConnectionsClientListByConfigurationStoreResponse

type PrivateEndpointConnectionsClientListByConfigurationStoreResponse struct {
	// A list of private endpoint connections
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByConfigurationStoreResponse contains the response from method PrivateEndpointConnectionsClient.NewListByConfigurationStorePager.

type PrivateLinkResource

type PrivateLinkResource struct {
	// Private link resource properties.
	Properties *PrivateLinkResourceProperties

	// READ-ONLY; The resource ID.
	ID *string

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

	// READ-ONLY; The type of the resource.
	Type *string
}

PrivateLinkResource - A resource that supports private link capabilities.

func (PrivateLinkResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string

	// The collection value.
	Value []*PrivateLinkResource
}

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.

func (*PrivateLinkResourceListResult) UnmarshalJSON

func (p *PrivateLinkResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string

	// READ-ONLY; The list of required DNS zone names of the private link resource.
	RequiredZoneNames []*string
}

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.

func (*PrivateLinkResourceProperties) UnmarshalJSON

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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.

Generated from API version 2023-03-01

  • 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/PrivateLinkResourceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "myResourceGroup", "contoso", "configurationStores", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateLinkResource = armappconfiguration.PrivateLinkResource{
// 	Name: to.Ptr("configurationStores"),
// 	Type: to.Ptr("Microsoft.AppConfiguraiton/configurationStores/privateLinkResources"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateLinkResources/configurationStores"),
// 	Properties: &armappconfiguration.PrivateLinkResourceProperties{
// 		GroupID: to.Ptr("configurationStores"),
// 		RequiredMembers: []*string{
// 			to.Ptr("configurationStores")},
// 			RequiredZoneNames: []*string{
// 				to.Ptr("privatelink.azconfig.io")},
// 			},
// 		}
Output:

func (*PrivateLinkResourcesClient) NewListByConfigurationStorePager

NewListByConfigurationStorePager - Gets the private link resources that need to be created for a configuration store.

Generated from API version 2023-03-01

  • 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.NewListByConfigurationStorePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/PrivateLinkResourcesListByConfigurationStore.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateLinkResourcesClient().NewListByConfigurationStorePager("myResourceGroup", "contoso", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateLinkResourceListResult = armappconfiguration.PrivateLinkResourceListResult{
	// 	Value: []*armappconfiguration.PrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("configurationStores"),
	// 			Type: to.Ptr("Microsoft.AppConfiguraiton/configurationStores/privateLinkResources"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateLinkResources/configurationStores"),
	// 			Properties: &armappconfiguration.PrivateLinkResourceProperties{
	// 				GroupID: to.Ptr("configurationStores"),
	// 				RequiredMembers: []*string{
	// 					to.Ptr("configurationStores")},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.azconfig.io")},
	// 					},
	// 			}},
	// 		}
}
Output:

type PrivateLinkResourcesClientGetOptions

type PrivateLinkResourcesClientGetOptions struct {
}

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

type PrivateLinkResourcesClientGetResponse

type PrivateLinkResourcesClientGetResponse struct {
	// A resource that supports private link capabilities.
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByConfigurationStoreOptions

type PrivateLinkResourcesClientListByConfigurationStoreOptions struct {
}

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

type PrivateLinkResourcesClientListByConfigurationStoreResponse

type PrivateLinkResourcesClientListByConfigurationStoreResponse struct {
	// A list of private link resources.
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByConfigurationStoreResponse contains the response from method PrivateLinkResourcesClient.NewListByConfigurationStorePager.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// The private link service connection description.
	Description *string

	// The private link service connection status.
	Status *ConnectionStatus

	// READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
	ActionsRequired *ActionsRequired
}

PrivateLinkServiceConnectionState - The state of a private link service connection.

func (PrivateLinkServiceConnectionState) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON

func (p *PrivateLinkServiceConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

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.

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.

type RegenerateKeyParameters

type RegenerateKeyParameters struct {
	// The id of the key to regenerate.
	ID *string
}

RegenerateKeyParameters - The parameters used to regenerate an API key.

func (RegenerateKeyParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RegenerateKeyParameters.

func (*RegenerateKeyParameters) UnmarshalJSON

func (r *RegenerateKeyParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegenerateKeyParameters.

type Replica

type Replica struct {
	// The location of the replica.
	Location *string

	// READ-ONLY; The resource ID.
	ID *string

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

	// READ-ONLY; All replica properties.
	Properties *ReplicaProperties

	// READ-ONLY; Resource system metadata.
	SystemData *SystemData

	// READ-ONLY; The type of the resource.
	Type *string
}

Replica - The replica resource.

func (Replica) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Replica.

func (*Replica) UnmarshalJSON

func (r *Replica) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Replica.

type ReplicaListResult

type ReplicaListResult struct {
	// The URI that can be used to request the next set of paged results.
	NextLink *string

	// The collection value.
	Value []*Replica
}

ReplicaListResult - The result of a request to list replicas.

func (ReplicaListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ReplicaListResult.

func (*ReplicaListResult) UnmarshalJSON

func (r *ReplicaListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaListResult.

type ReplicaProperties

type ReplicaProperties struct {
	// READ-ONLY; The URI of the replica where the replica API will be available.
	Endpoint *string

	// READ-ONLY; The provisioning state of the replica.
	ProvisioningState *ReplicaProvisioningState
}

ReplicaProperties - All replica properties.

func (ReplicaProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ReplicaProperties.

func (*ReplicaProperties) UnmarshalJSON

func (r *ReplicaProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaProperties.

type ReplicaProvisioningState

type ReplicaProvisioningState string

ReplicaProvisioningState - The provisioning state of the replica.

const (
	ReplicaProvisioningStateCanceled  ReplicaProvisioningState = "Canceled"
	ReplicaProvisioningStateCreating  ReplicaProvisioningState = "Creating"
	ReplicaProvisioningStateDeleting  ReplicaProvisioningState = "Deleting"
	ReplicaProvisioningStateFailed    ReplicaProvisioningState = "Failed"
	ReplicaProvisioningStateSucceeded ReplicaProvisioningState = "Succeeded"
)

func PossibleReplicaProvisioningStateValues

func PossibleReplicaProvisioningStateValues() []ReplicaProvisioningState

PossibleReplicaProvisioningStateValues returns the possible values for the ReplicaProvisioningState const type.

type ReplicasClient

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

ReplicasClient contains the methods for the Replicas group. Don't use this type directly, use NewReplicasClient() instead.

func NewReplicasClient

func NewReplicasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ReplicasClient, error)

NewReplicasClient creates a new instance of ReplicasClient 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 (*ReplicasClient) BeginCreate

func (client *ReplicasClient) BeginCreate(ctx context.Context, resourceGroupName string, configStoreName string, replicaName string, replicaCreationParameters Replica, options *ReplicasClientBeginCreateOptions) (*runtime.Poller[ReplicasClientCreateResponse], error)

BeginCreate - Creates a replica with the specified parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • resourceGroupName - The name of the resource group to which the container registry belongs.
  • configStoreName - The name of the configuration store.
  • replicaName - The name of the replica.
  • replicaCreationParameters - The parameters for creating a replica.
  • options - ReplicasClientBeginCreateOptions contains the optional parameters for the ReplicasClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresCreateReplica.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewReplicasClient().BeginCreate(ctx, "myResourceGroup", "contoso", "myReplicaEus", armappconfiguration.Replica{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Replica = armappconfiguration.Replica{
// 	Name: to.Ptr("myReplicaEus"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/replicas"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/replicas/myReplicaEus"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappconfiguration.ReplicaProperties{
// 		Endpoint: to.Ptr("https://contoso-myreplicaeus.azconfig.io"),
// 		ProvisioningState: to.Ptr(armappconfiguration.ReplicaProvisioningStateSucceeded),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

func (*ReplicasClient) BeginDelete

func (client *ReplicasClient) BeginDelete(ctx context.Context, resourceGroupName string, configStoreName string, replicaName string, options *ReplicasClientBeginDeleteOptions) (*runtime.Poller[ReplicasClientDeleteResponse], error)

BeginDelete - Deletes a replica. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • resourceGroupName - The name of the resource group to which the container registry belongs.
  • configStoreName - The name of the configuration store.
  • replicaName - The name of the replica.
  • options - ReplicasClientBeginDeleteOptions contains the optional parameters for the ReplicasClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresDeleteReplica.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewReplicasClient().BeginDelete(ctx, "myResourceGroup", "contoso", "myReplicaEus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ReplicasClient) Get

func (client *ReplicasClient) Get(ctx context.Context, resourceGroupName string, configStoreName string, replicaName string, options *ReplicasClientGetOptions) (ReplicasClientGetResponse, error)

Get - Gets the properties of the specified replica. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-03-01

  • resourceGroupName - The name of the resource group to which the container registry belongs.
  • configStoreName - The name of the configuration store.
  • replicaName - The name of the replica.
  • options - ReplicasClientGetOptions contains the optional parameters for the ReplicasClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresGetReplica.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewReplicasClient().Get(ctx, "myResourceGroup", "contoso", "myReplicaEus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Replica = armappconfiguration.Replica{
// 	Name: to.Ptr("myReplicaEus"),
// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/replicas"),
// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/replicas/myReplicaEus"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armappconfiguration.ReplicaProperties{
// 		Endpoint: to.Ptr("https://contoso-myreplicaeus.azconfig.io"),
// 		ProvisioningState: to.Ptr(armappconfiguration.ReplicaProvisioningStateSucceeded),
// 	},
// 	SystemData: &armappconfiguration.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		CreatedBy: to.Ptr("foo@contoso.com"),
// 		CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("foo@contoso.com"),
// 		LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// 	},
// }
Output:

func (*ReplicasClient) NewListByConfigurationStorePager

func (client *ReplicasClient) NewListByConfigurationStorePager(resourceGroupName string, configStoreName string, options *ReplicasClientListByConfigurationStoreOptions) *runtime.Pager[ReplicasClientListByConfigurationStoreResponse]

NewListByConfigurationStorePager - Lists the replicas for a given configuration store.

Generated from API version 2023-03-01

  • resourceGroupName - The name of the resource group to which the container registry belongs.
  • configStoreName - The name of the configuration store.
  • options - ReplicasClientListByConfigurationStoreOptions contains the optional parameters for the ReplicasClient.NewListByConfigurationStorePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresListReplicas.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewReplicasClient().NewListByConfigurationStorePager("myResourceGroup", "contoso", &armappconfiguration.ReplicasClientListByConfigurationStoreOptions{SkipToken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ReplicaListResult = armappconfiguration.ReplicaListResult{
	// 	Value: []*armappconfiguration.Replica{
	// 		{
	// 			Name: to.Ptr("myReplicaEus"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/replicas"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/replicas/myReplicaEus"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armappconfiguration.ReplicaProperties{
	// 				Endpoint: to.Ptr("https://contoso-myreplicaeus.azconfig.io"),
	// 				ProvisioningState: to.Ptr(armappconfiguration.ReplicaProvisioningStateSucceeded),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("myReplicaWestEurope"),
	// 			Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/replicas"),
	// 			ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/replicas/myReplicaWestEurope"),
	// 			Location: to.Ptr("westeurope"),
	// 			Properties: &armappconfiguration.ReplicaProperties{
	// 				Endpoint: to.Ptr("https://contoso-myreplicawesteurope.azconfig.io"),
	// 				ProvisioningState: to.Ptr(armappconfiguration.ReplicaProvisioningStateSucceeded),
	// 			},
	// 			SystemData: &armappconfiguration.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("foo@contoso.com"),
	// 				CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 				LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
	// 			},
	// 	}},
	// }
}
Output:

type ReplicasClientBeginCreateOptions

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

ReplicasClientBeginCreateOptions contains the optional parameters for the ReplicasClient.BeginCreate method.

type ReplicasClientBeginDeleteOptions

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

ReplicasClientBeginDeleteOptions contains the optional parameters for the ReplicasClient.BeginDelete method.

type ReplicasClientCreateResponse

type ReplicasClientCreateResponse struct {
	// The replica resource.
	Replica
}

ReplicasClientCreateResponse contains the response from method ReplicasClient.BeginCreate.

type ReplicasClientDeleteResponse

type ReplicasClientDeleteResponse struct {
}

ReplicasClientDeleteResponse contains the response from method ReplicasClient.BeginDelete.

type ReplicasClientGetOptions

type ReplicasClientGetOptions struct {
}

ReplicasClientGetOptions contains the optional parameters for the ReplicasClient.Get method.

type ReplicasClientGetResponse

type ReplicasClientGetResponse struct {
	// The replica resource.
	Replica
}

ReplicasClientGetResponse contains the response from method ReplicasClient.Get.

type ReplicasClientListByConfigurationStoreOptions

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

ReplicasClientListByConfigurationStoreOptions contains the optional parameters for the ReplicasClient.NewListByConfigurationStorePager method.

type ReplicasClientListByConfigurationStoreResponse

type ReplicasClientListByConfigurationStoreResponse struct {
	// The result of a request to list replicas.
	ReplicaListResult
}

ReplicasClientListByConfigurationStoreResponse contains the response from method ReplicasClient.NewListByConfigurationStorePager.

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

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

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

func (Resource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceIdentity

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

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

	// READ-ONLY; The principal id of the identity. This property will only be provided for a system-assigned identity.
	PrincipalID *string

	// READ-ONLY; The tenant id associated with the resource's identity. This property will only be provided for a system-assigned
	// identity.
	TenantID *string
}

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.

func (*ResourceIdentity) UnmarshalJSON

func (r *ResourceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceIdentity.

type SKU

type SKU struct {
	// REQUIRED; The SKU name of the configuration store.
	Name *string
}

SKU - Describes a configuration store SKU.

func (SKU) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type ServiceSpecification

type ServiceSpecification struct {
	// Specifications of the Log for Azure Monitoring
	LogSpecifications []*LogSpecification

	// Specifications of the Metrics for Azure Monitoring
	MetricSpecifications []*MetricSpecification
}

ServiceSpecification - Service specification payload

func (ServiceSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

func (*ServiceSpecification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceSpecification.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

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

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

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

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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.

func (*TrackedResource) UnmarshalJSON

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type UserIdentity

type UserIdentity struct {
	// READ-ONLY; The client ID of the user-assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the user-assigned identity.
	PrincipalID *string
}

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

func (UserIdentity) MarshalJSON

func (u UserIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserIdentity.

func (*UserIdentity) UnmarshalJSON

func (u *UserIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserIdentity.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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