Bearbeiten

Freigeben über


Remove-AzAppConfigurationKeyValue

Deletes a key-value.

Syntax

Remove-AzAppConfigurationKeyValue
      -Endpoint <String>
      -Key <String>
      [-Label <String>]
      [-IfMatch <String>]
      [-SyncToken <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzAppConfigurationKeyValue
      -Endpoint <String>
      -InputObject <IAppConfigurationdataIdentity>
      [-Label <String>]
      [-IfMatch <String>]
      [-SyncToken <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Deletes a key-value.

Examples

Example 1: Remove a key-value in an App Configuration store

Remove-AzAppConfigurationKeyValue -Endpoint $endpoint -Key keyName1

ContentType  :
Etag         : jXrYtz3qx3qEP0icqPfFWmD24a6qvOnR5LO08NseiR0
Key          : keyName1
Label        :
LastModified : 7/21/2023 02:49:20
Locked       : True
SyncToken    : xxxxxx
Tag          : {
               }
Value        : value1

Remove a key-value in 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

-Endpoint

The endpoint of the App Configuration instance to send requests to.

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

-IfMatch

Used to perform an operation only if the targeted resource's etag matches the value provided.

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

-InputObject

Identity Parameter

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

-Key

The key of the key-value to delete.

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

-Label

The label of the key-value to delete.

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

-PassThru

Returns true when the command succeeds

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

-SyncToken

Used to guarantee real-time consistency between requests.

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

IAppConfigurationdataIdentity

Outputs

IKeyValue