ConfigurationStores interface
Interface representing a ConfigurationStores.
Methods
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
The options parameters.
Returns
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.
The options parameters.
Returns
listDeleted(ConfigurationStoresListDeletedOptionalParams)
Gets information about the deleted configuration stores in a subscription.
function listDeleted(options?: ConfigurationStoresListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedConfigurationStore, DeletedConfigurationStore[], PageSettings>
Parameters
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ApiKey>