Skip to content

Latest commit

 

History

History
124 lines (96 loc) · 3.18 KB

File metadata and controls

124 lines (96 loc) · 3.18 KB
external help file Module Name online version schema
AzureRmStorageTableCoreHelper-help.xml
azurermstoragetable
2.0.0

Remove-AzTableRow

SYNOPSIS

Remove-AzTableRow - Removes a specified table row

SYNTAX

byEntityPSObjectObject

Remove-AzTableRow -Table <Object> -entity <Object> [<CommonParameters>]

byPartitionandRowKeys

Remove-AzTableRow -Table <Object> -PartitionKey <String> -RowKey <String> [<CommonParameters>]

DESCRIPTION

Remove-AzTableRow - Removes a specified table row. It accepts multiple deletions through the Pipeline when passing entities returned from the Get-AzTableRow available cmdlets. It also can delete a row/entity using Partition and Row Key properties directly.

EXAMPLES

EXAMPLE 1

# Deleting an entry by entity PS Object
[string]$Filter1 = [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("firstName",[Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,"Paulo")
[string]$Filter2 = [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("lastName",[Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,"Marques")
[string]$finalFilter = [Microsoft.Azure.Cosmos.Table.TableQuery]::CombineFilters($Filter1,"and",$Filter2)
$personToDelete = Get-AzTableRowByCustomFilter -Table $Table -CustomFilter $finalFilter
$personToDelete | Remove-AzTableRow -Table $Table

EXAMPLE 2

# Deleting an entry by using PartitionKey and row key directly
Remove-AzTableRow -Table $Table -PartitionKey "TableEntityDemoFullList" -RowKey "399b58af-4f26-48b4-9b40-e28a8b03e867"

EXAMPLE 3

# Deleting everything
Get-AzTableRowAll -Table $Table | Remove-AzTableRow -Table $Table

PARAMETERS

-Table

Table object of type Microsoft.Azure.Cosmos.Table.CloudTable where the entity exists

Type: Object
Parameter Sets: (All)
Aliases:

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

-entity

{{ Fill entity Description }}

Type: Object
Parameter Sets: byEntityPSObjectObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PartitionKey

{{ Fill PartitionKey Description }}

Type: String
Parameter Sets: byPartitionandRowKeys
Aliases:

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

-RowKey

{{ Fill RowKey Description }}

Type: String
Parameter Sets: byPartitionandRowKeys
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS