Skip to content

Get-AzTableRowByColumnName.md

Latest commit

 

History

History
146 lines (113 loc) · 3.06 KB

Get-AzTableRowByColumnName.md

File metadata and controls

146 lines (113 loc) · 3.06 KB
external help file Module Name online version schema
AzureRmStorageTableCoreHelper-help.xml
azurermstoragetable
2.0.0

Get-AzTableRowByColumnName

SYNOPSIS

Returns one or more rows/entities based on a specified column and its value

SYNTAX

byString

Get-AzTableRowByColumnName -Table <Object> -ColumnName <String> -Value <String> -Operator <String>
 [-Top <Int32>] [<CommonParameters>]

byGuid

Get-AzTableRowByColumnName -Table <Object> -ColumnName <String> -GuidValue <Guid> -Operator <String>
 [-Top <Int32>] [<CommonParameters>]

DESCRIPTION

Returns one or more rows/entities based on a specified column and its value

EXAMPLES

EXAMPLE 1

# Getting row by firstname
Get-AzTableRowByColumnName -Table $Table -ColumnName "firstName" -value "Paulo" -Operator Equal

EXAMPLE 2

# Getting row by firstname with a maximum number of rows returned
Get-AzTableRowByColumnName -Table $Table -ColumnName "firstName" -value "Paulo" -Operator Equal -Top 10

PARAMETERS

-Table

Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities

Type: Object
Parameter Sets: (All)
Aliases:

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

-ColumnName

Column name to compare the value to

Type: String
Parameter Sets: (All)
Aliases:

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

-Value

Value that will be looked for in the defined column

Type: String
Parameter Sets: byString
Aliases:

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

-GuidValue

Value that will be looked for in the defined column as Guid

Type: Guid
Parameter Sets: byGuid
Aliases:

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

-Operator

Supported comparison Operator. Valid values are "Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual"

Type: String
Parameter Sets: (All)
Aliases:

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

-Top

Return only the first n rows from the query

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
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