New-AzAppConfigurationStoreKey

Reference

Module:: Az.AppConfiguration

Regenerates an access key for the specified configuration store.

Syntax

New-AzAppConfigurationStoreKey
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Id <String>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAppConfigurationStoreKey
   -InputObject <IAppConfigurationIdentity>
   -Id <String>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Regenerates an access key for the specified configuration store.

Examples

Example 1: Regenerate key of an app configuration store

$keys = Get-AzAppConfigurationStoreKey -Name azpstest-appstore -ResourceGroupName azpstest_gp
New-AzAppConfigurationStoreKey -Name azpstest-appstore -ResourceGroupName azpstest_gp -Id $keys[0].id

ConnectionString                                                                                                                      LastModified           Name    ReadOnly ResourceGroupName Value
----------------                                                                                                                      ------------           ----    -------- ----------------- -----
Endpoint=https://azpstest-appstore.azconfig.io;Id=m6TW-l0-s0:g302jTPLEpvmI0AahitF;Secret=vt5aKm6ezq2iVKNjQo+dQpA8QyuH1UhH9Jv8N3jfZdE= 2022-08-24 AM 06:13:21 Primary False                      vt5aKm6ezq2iV…

This command regenerate key of an app configuration store.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

The id of the key to regenerate.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IAppConfigurationIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the configuration store.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The Microsoft Azure subscription ID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IAppConfigurationIdentity

Outputs

IApiKey

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IAppConfigurationIdentity>: Identity Parameter

[ConfigStoreName <String>]: The name of the configuration store.
[GroupName <String>]: The name of the private link resource group.
[Id <String>]: Resource identity path
[KeyValueName <String>]: Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
[Location <String>]: The location in which uniqueness will be verified.
[PrivateEndpointConnectionName <String>]: Private endpoint connection name
[ResourceGroupName <String>]: The name of the resource group to which the container registry belongs.
[SubscriptionId <String>]: The Microsoft Azure subscription ID.