Update-AzAppConfigurationStore

Updates a configuration store with the specified parameters.

Syntax

Update-AzAppConfigurationStore
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DisableLocalAuth]
      [-EnablePurgeProtection]
      [-EncryptionKeyIdentifier <String>]
      [-IdentityType <IdentityType>]
      [-KeyVaultIdentityClientId <String>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-Sku <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzAppConfigurationStore
      -InputObject <IAppConfigurationIdentity>
      [-DisableLocalAuth]
      [-EnablePurgeProtection]
      [-EncryptionKeyIdentifier <String>]
      [-IdentityType <IdentityType>]
      [-KeyVaultIdentityClientId <String>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-Sku <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a configuration store with the specified parameters.

Examples

Example 1: Updates a configuration store with the specified parameters.

Update-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp -DisableLocalAuth -EnablePurgeProtection -PublicNetworkAccess 'Enabled'

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azpstest-appstore azpstest_gp

Updates a configuration store with the specified parameters.

Example 2: Updates a configuration store with the specified parameters.

Get-AzAppConfigurationStore -Name azpstest-appstore -ResourceGroupName azpstest_gp | Update-AzAppConfigurationStore -DisableLocalAuth -EnablePurgeProtection -PublicNetworkAccess 'Enabled'

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azpstest-appstore azpstest_gp

Updates a configuration store with the specified parameters.

Parameters

-AsJob

Run the command as a job

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

-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 credentials, account, tenant, and subscription used for communication with Azure.

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

-DisableLocalAuth

Disables all authentication methods other than AAD authentication.

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

-EnablePurgeProtection

Property specifying whether protection against purge is enabled for this configuration store.

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

-EncryptionKeyIdentifier

The URI of the key vault key used to encrypt data.

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

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

Type:IdentityType
Position:Named
Default value:None
Required:False
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

-KeyVaultIdentityClientId

The client id of the identity which will be used to access key vault.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-NoWait

Run the command asynchronously

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

-PublicNetworkAccess

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

Type:PublicNetworkAccess
Position:Named
Default value:None
Required:False
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

-Sku

The SKU name of the configuration store.

Type:String
Position:Named
Default value:None
Required:False
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

-Tag

The ARM resource tags.

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

-UserAssignedIdentity

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}'.

Type:String[]
Position:Named
Default value:None
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

IConfigurationStore

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.