Edit

Share via


Update-AzAppConfigurationStore

update a configuration store with the specified parameters.

Syntax

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

Description

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

-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

-EnableSystemAssignedIdentity

Determines whether to enable a system-assigned identity for the resource.

Type:Nullable<T>[Boolean]
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

-InputObject

Identity Parameter

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:String
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

-SoftDeleteRetentionInDay

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

Type:Int32
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

Resource tags.

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

-UserAssignedIdentity

The array of user assigned identities associated with the resource. The elements in array 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