ConfigurationStores interface

Package:

@azure/arm-appconfiguration

Interface representing a ConfigurationStores.

Methods

beginCreate(string, string, ConfigurationStore, ConfigurationStoresCreateOptionalParams)	Creates a configuration store with the specified parameters.
beginCreateAndWait(string, string, ConfigurationStore, ConfigurationStoresCreateOptionalParams)	Creates a configuration store with the specified parameters.
beginDelete(string, string, ConfigurationStoresDeleteOptionalParams)	Deletes a configuration store.
beginDeleteAndWait(string, string, ConfigurationStoresDeleteOptionalParams)	Deletes a configuration store.
beginPurgeDeleted(string, string, ConfigurationStoresPurgeDeletedOptionalParams)	Permanently deletes the specified configuration store.
beginPurgeDeletedAndWait(string, string, ConfigurationStoresPurgeDeletedOptionalParams)	Permanently deletes the specified configuration store.
beginUpdate(string, string, ConfigurationStoreUpdateParameters, ConfigurationStoresUpdateOptionalParams)	Updates a configuration store with the specified parameters.
beginUpdateAndWait(string, string, ConfigurationStoreUpdateParameters, ConfigurationStoresUpdateOptionalParams)	Updates a configuration store with the specified parameters.
get(string, string, ConfigurationStoresGetOptionalParams)	Gets the properties of the specified configuration store.
getDeleted(string, string, ConfigurationStoresGetDeletedOptionalParams)	Gets a deleted Azure app configuration store.
list(ConfigurationStoresListOptionalParams)	Lists the configuration stores for a given subscription.
listByResourceGroup(string, ConfigurationStoresListByResourceGroupOptionalParams)	Lists the configuration stores for a given resource group.
listDeleted(ConfigurationStoresListDeletedOptionalParams)	Gets information about the deleted configuration stores in a subscription.
listKeys(string, string, ConfigurationStoresListKeysOptionalParams)	Lists the access key for the specified configuration store.
regenerateKey(string, string, RegenerateKeyParameters, ConfigurationStoresRegenerateKeyOptionalParams)	Regenerates an access key for the specified configuration store.

Method Details

beginCreate(string, string, ConfigurationStore, ConfigurationStoresCreateOptionalParams)

Creates a configuration store with the specified parameters.

function beginCreate(resourceGroupName: string, configStoreName: string, configStoreCreationParameters: ConfigurationStore, options?: ConfigurationStoresCreateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationStore>, ConfigurationStore>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

configStoreCreationParameters

ConfigurationStore

The parameters for creating a configuration store.

options

ConfigurationStoresCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConfigurationStore>, ConfigurationStore>>

beginCreateAndWait(string, string, ConfigurationStore, ConfigurationStoresCreateOptionalParams)

Creates a configuration store with the specified parameters.

function beginCreateAndWait(resourceGroupName: string, configStoreName: string, configStoreCreationParameters: ConfigurationStore, options?: ConfigurationStoresCreateOptionalParams): Promise<ConfigurationStore>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

configStoreCreationParameters

ConfigurationStore

The parameters for creating a configuration store.

options

ConfigurationStoresCreateOptionalParams

The options parameters.

Returns

Promise<ConfigurationStore>

beginDelete(string, string, ConfigurationStoresDeleteOptionalParams)

Deletes a configuration store.

function beginDelete(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ConfigurationStoresDeleteOptionalParams)

Deletes a configuration store.

function beginDeleteAndWait(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPurgeDeleted(string, string, ConfigurationStoresPurgeDeletedOptionalParams)

Permanently deletes the specified configuration store.

function beginPurgeDeleted(location: string, configStoreName: string, options?: ConfigurationStoresPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

location

string

The location in which uniqueness will be verified.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresPurgeDeletedOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginPurgeDeletedAndWait(string, string, ConfigurationStoresPurgeDeletedOptionalParams)

Permanently deletes the specified configuration store.

function beginPurgeDeletedAndWait(location: string, configStoreName: string, options?: ConfigurationStoresPurgeDeletedOptionalParams): Promise<void>

Parameters

location

string

The location in which uniqueness will be verified.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresPurgeDeletedOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ConfigurationStoreUpdateParameters, ConfigurationStoresUpdateOptionalParams)

Updates a configuration store with the specified parameters.

function beginUpdate(resourceGroupName: string, configStoreName: string, configStoreUpdateParameters: ConfigurationStoreUpdateParameters, options?: ConfigurationStoresUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationStore>, ConfigurationStore>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

configStoreUpdateParameters

ConfigurationStoreUpdateParameters

The parameters for updating a configuration store.

options

ConfigurationStoresUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConfigurationStore>, ConfigurationStore>>

beginUpdateAndWait(string, string, ConfigurationStoreUpdateParameters, ConfigurationStoresUpdateOptionalParams)

Updates a configuration store with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, configStoreName: string, configStoreUpdateParameters: ConfigurationStoreUpdateParameters, options?: ConfigurationStoresUpdateOptionalParams): Promise<ConfigurationStore>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

configStoreUpdateParameters

ConfigurationStoreUpdateParameters

The parameters for updating a configuration store.

options

ConfigurationStoresUpdateOptionalParams

The options parameters.

Returns

Promise<ConfigurationStore>

get(string, string, ConfigurationStoresGetOptionalParams)

Gets the properties of the specified configuration store.

function get(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresGetOptionalParams): Promise<ConfigurationStore>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresGetOptionalParams

The options parameters.

Returns

Promise<ConfigurationStore>

getDeleted(string, string, ConfigurationStoresGetDeletedOptionalParams)

Gets a deleted Azure app configuration store.

function getDeleted(location: string, configStoreName: string, options?: ConfigurationStoresGetDeletedOptionalParams): Promise<DeletedConfigurationStore>

Parameters

location

string

The location in which uniqueness will be verified.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresGetDeletedOptionalParams

The options parameters.

Returns

Promise<DeletedConfigurationStore>

list(ConfigurationStoresListOptionalParams)

Lists the configuration stores for a given subscription.

function list(options?: ConfigurationStoresListOptionalParams): PagedAsyncIterableIterator<ConfigurationStore, ConfigurationStore[], PageSettings>

Parameters

options

ConfigurationStoresListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConfigurationStore, ConfigurationStore[], PageSettings>

listByResourceGroup(string, ConfigurationStoresListByResourceGroupOptionalParams)

Lists the configuration stores for a given resource group.

function listByResourceGroup(resourceGroupName: string, options?: ConfigurationStoresListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConfigurationStore, ConfigurationStore[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

options

ConfigurationStoresListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConfigurationStore, ConfigurationStore[], PageSettings>

listDeleted(ConfigurationStoresListDeletedOptionalParams)

Gets information about the deleted configuration stores in a subscription.

function listDeleted(options?: ConfigurationStoresListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedConfigurationStore, DeletedConfigurationStore[], PageSettings>

Parameters

options

ConfigurationStoresListDeletedOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeletedConfigurationStore, DeletedConfigurationStore[], PageSettings>

listKeys(string, string, ConfigurationStoresListKeysOptionalParams)

Lists the access key for the specified configuration store.

function listKeys(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresListKeysOptionalParams): PagedAsyncIterableIterator<ApiKey, ApiKey[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

options

ConfigurationStoresListKeysOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApiKey, ApiKey[], PageSettings>

regenerateKey(string, string, RegenerateKeyParameters, ConfigurationStoresRegenerateKeyOptionalParams)

Regenerates an access key for the specified configuration store.

function regenerateKey(resourceGroupName: string, configStoreName: string, regenerateKeyParameters: RegenerateKeyParameters, options?: ConfigurationStoresRegenerateKeyOptionalParams): Promise<ApiKey>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

regenerateKeyParameters

RegenerateKeyParameters

The parameters for regenerating an access key.

options

ConfigurationStoresRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<ApiKey>