AzureRmStorageTableCoreHelper.psm1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 |
<# .SYNOPSIS AzureRmStorageTableCoreHelper.psm1 - PowerShell Module that contains all functions related to manipulating Azure Storage Table rows/entities. .DESCRIPTION AzureRmStorageTableCoreHelper.psm1 - PowerShell Module that contains all functions related to manipulating Azure Storage Table rows/entities. .NOTES This module depends on Az.Accounts, Az.Resources and Az.Storage PowerShell modules #> [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 #Requires -modules Az.Storage, Az.Resources # Deprecated Message $DeprecatedMessage = "IMPORTANT: This function is deprecated and will be removed in the next release, please use Get-AzTableRow instead." # Module Functions function TestAzTableEmptyKeys { param ( [Parameter(Mandatory=$true)] $PartitionKey, [Parameter(Mandatory=$true)] $RowKey ) $CosmosEmptyKeysErrorMessage = "Cosmos DB table API does not accept empty partition or row keys when using CloudTable.Execute operation, because of this we are disabling this capability in this module and it will not proceed." if ([string]::IsNullOrEmpty($PartitionKey) -or [string]::IsNullOrEmpty($RowKey)) { Throw $CosmosEmptyKeysErrorMessage } } function ExecuteQueryAsync { param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] $TableQuery ) # Internal function # Executes query in async mode if ($TableQuery -ne $null) { $token = $null $AllRows = @() do { $Results = $Table.ExecuteQuerySegmentedAsync($TableQuery, $token) $token = $Results.Result.ContinuationToken $AllRows += $Results.Result.Results # TakeCount controls the number of results returned per page, not # for the entire query. See e.g. the note in # https://docs.microsoft.com/azure/cosmos-db/table-storage-design-guide#retrieve-large-numbers-of-entities-from-a-query if (($null -ne $token) -and ($null -ne $TableQuery.TakeCount)) { # If the take count is larger than the number of rows in this # segment, there are more rows to return. if ($TableQuery.TakeCount -gt $Results.Result.Results.Count) { $TableQuery.TakeCount -= $Results.Result.Results.Count } else { # No more rows are available in the current page. break } } } while ($token) return $AllRows } } function GetPSObjectFromEntity($entityList) { # Internal function # Converts entities output from the ExecuteQuery method of table into an array of PowerShell Objects $returnObjects = @() if (-not [string]::IsNullOrEmpty($entityList)) { foreach ($entity in $entityList) { $entityNewObj = New-Object -TypeName psobject $entity.Properties.Keys | ForEach-Object {Add-Member -InputObject $entityNewObj -Name $_ -Value $entity.Properties[$_].PropertyAsObject -MemberType NoteProperty} # Adding table entity other attributes Add-Member -InputObject $entityNewObj -Name "PartitionKey" -Value $entity.PartitionKey -MemberType NoteProperty Add-Member -InputObject $entityNewObj -Name "RowKey" -Value $entity.RowKey -MemberType NoteProperty Add-Member -InputObject $entityNewObj -Name "TableTimestamp" -Value $entity.Timestamp -MemberType NoteProperty Add-Member -InputObject $entityNewObj -Name "Etag" -Value $entity.Etag -MemberType NoteProperty $returnObjects += $entityNewObj } } return $returnObjects } function Get-AzTableTable { <# .SYNOPSIS Gets a Table object to be used in all other cmdlets. .DESCRIPTION Gets a Table object to be used in all other cmdlets. .PARAMETER resourceGroup Resource Group where the Azure Storage Account is located .PARAMETER tableName Name of the table to retrieve .PARAMETER storageAccountName Storage Account name where the table lives .EXAMPLE # Getting storage table object $resourceGroup = "myResourceGroup" $storageAccount = "myStorageAccountName" $TableName = "table01" $Table = Get-AzTabletable -resourceGroup $resourceGroup -tableName $TableName -storageAccountName $storageAccount #> [CmdletBinding()] param ( [Parameter(ParameterSetName="AzTableStorage",Mandatory=$true)] [string]$resourceGroup, [Parameter(Mandatory=$true)] [String]$TableName, [Parameter(ParameterSetName="AzTableStorage",Mandatory=$true)] [String]$storageAccountName, [Parameter(ParameterSetName="AzStorageEmulator",Mandatory=$true)] [switch]$UseStorageEmulator ) # Validating name if ($TableName.Contains("_") -or $TableName.Contains("-")) { throw "Invalid table name: $TableName" } $nullTableErrorMessage = [string]::Empty if ($PSCmdlet.ParameterSetName -ne "AzStorageEmulator") { $keys = Invoke-AzResourceAction -Action listKeys -ResourceType "Microsoft.Storage/storageAccounts" -ApiVersion "2017-10-01" -ResourceGroupName $resourceGroup -Name $storageAccountName -Force if ($keys -ne $null) { if ($PSCmdlet.ParameterSetName -eq "AzTableStorage" ) { $key = $keys.keys[0].value $endpoint = "https://{0}.table.core.windows.net" $nullTableErrorMessage = "Table $TableName could not be retrieved from $storageAccountName on resource group $resourceGroupName" } else { # Future Cosmos implementation # $key = $keys.primaryMasterKey # $endpoint = "https://{0}.table.Cosmos.azure.com" # $nullTableErrorMessage = "Table $TableName could not be retrieved from $<<<TDB VAR>>> on resource group $resourceGroupName" } } else { throw "An error ocurred while obtaining keys from $storageAccountName." } $connString = [string]::Format("DefaultEndpointsProtocol=https;AccountName={0};AccountKey={1};TableEndpoint=$endpoint",$storageAccountName,$key) [Microsoft.Azure.Cosmos.Table.CloudStorageAccount]$storageAccount = [Microsoft.Azure.Cosmos.Table.CloudStorageAccount]::Parse($connString) [Microsoft.Azure.Cosmos.Table.CloudTableClient]$TableClient = [Microsoft.Azure.Cosmos.Table.CloudTableClient]::new($storageAccount.TableEndpoint,$storageAccount.Credentials) [Microsoft.Azure.Cosmos.Table.CloudTable]$Table = [Microsoft.Azure.Cosmos.Table.CloudTable]$TableClient.GetTableReference($TableName) $Table.CreateIfNotExistsAsync() | Out-Null } else { # https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator $nullTableErrorMessage = "Table $TableName could not be retrieved from Azure Storage Emulator" $connString ="DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=http://127.0.0.1:10002/devstoreaccount1" [Microsoft.Azure.Cosmos.Table.CloudStorageAccount]$storageAccount = [Microsoft.Azure.Cosmos.Table.CloudStorageAccount]::Parse($connString) [Microsoft.Azure.Cosmos.Table.CloudTableClient]$TableClient = [Microsoft.Azure.Cosmos.Table.CloudTableClient]::new($storageAccount.TableEndpoint,$storageAccount.Credentials) [Microsoft.Azure.Cosmos.Table.CloudTable]$Table = [Microsoft.Azure.Cosmos.Table.CloudTable]$TableClient.GetTableReference($TableName) $Table.CreateIfNotExistsAsync() | Out-Null } # Checking if there a table got returned if ($Table -eq $null) { throw $nullTableErrorMessage } return $Table } function Add-AzTableRow { <# .SYNOPSIS Adds a row/entity to a specified table .DESCRIPTION Adds a row/entity to a specified table .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable where the entity will be added .PARAMETER PartitionKey Identifies the table partition .PARAMETER RowKey Identifies a row within a partition .PARAMETER Property Hashtable with the columns that will be part of the entity. e.g. @{"firstName"="Paulo";"lastName"="Marques"} .PARAMETER UpdateExisting Signalizes that command should update existing row, if such found by PartitionKey and RowKey. If not found, new row is added. .EXAMPLE # Adding a row Add-AzTableRow -Table $Table -PartitionKey $PartitionKey -RowKey ([guid]::NewGuid().tostring()) -property @{"firstName"="Paulo";"lastName"="Costa";"role"="presenter"} #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] [AllowEmptyString()] [String]$PartitionKey, [Parameter(Mandatory=$true)] [AllowEmptyString()] [String]$RowKey, [Parameter(Mandatory=$false)] [hashtable]$property, [Switch]$UpdateExisting ) # Creates the table entity with mandatory PartitionKey and RowKey arguments $entity = New-Object -TypeName "Microsoft.Azure.Cosmos.Table.DynamicTableEntity" -ArgumentList $PartitionKey, $RowKey # Adding the additional columns to the table entity foreach ($prop in $property.Keys) { if ($prop -ne "TableTimestamp") { $entity.Properties.Add($prop, $property.Item($prop)) } } if ($UpdateExisting) { return ($Table.Execute([Microsoft.Azure.Cosmos.Table.TableOperation]::InsertOrReplace($entity))) } else { return ($Table.Execute([Microsoft.Azure.Cosmos.Table.TableOperation]::Insert($entity))) } } function Get-AzTableRowAll { <# .SYNOPSIS Returns all rows/entities from a storage table - no Filtering .DESCRIPTION Returns all rows/entities from a storage table - no Filtering .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities .EXAMPLE # Getting all rows Get-AzTableRowAll -Table $Table #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table ) Write-Verbose $DeprecatedMessage -Verbose # No Filtering $Result = Get-AzTableRow -Table $Table if (-not [string]::IsNullOrEmpty($Result)) { return $Result } } function Get-AzTableRowByPartitionKey { <# .SYNOPSIS Returns one or more rows/entities based on Partition Key .DESCRIPTION Returns one or more rows/entities based on Partition Key .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities .PARAMETER PartitionKey Identifies the table partition .PARAMETER Top Return only the first n rows from the query .EXAMPLE # Getting rows by partition Key Get-AzTableRowByPartitionKey -Table $Table -PartitionKey "mypartitionkey" .EXAMPLE # Getting rows by partition key with a maximum number returned Get-AzTableRowByPartitionKey -Table $Table -PartitionKey "mypartitionkey" -Top 10 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] [AllowEmptyString()] [string]$PartitionKey, [Parameter(Mandatory=$false)] [Nullable[Int32]]$Top = $null ) Write-Verbose $DeprecatedMessage -Verbose # Filtering by Partition Key $Result = Get-AzTableRow -Table $Table -PartitionKey $PartitionKey -Top $Top if (-not [string]::IsNullOrEmpty($Result)) { return $Result } } function Get-AzTableRowByPartitionKeyRowKey { <# .SYNOPSIS Returns one entity based on Partition Key and RowKey .DESCRIPTION Returns one entity based on Partition Key and RowKey .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities .PARAMETER PartitionKey Identifies the table partition .PARAMETER RowKey Identifies the row key in the partition .PARAMETER Top Return only the first n rows from the query .EXAMPLE # Getting rows by Partition Key and Row Key Get-AzStorageTableRowByPartitionKeyRowKey -Table $Table -PartitionKey "partition1" -RowKey "id12345" .EXAMPLE # Getting rows by Partition Key and Row Key, with a maximum number returned Get-AzStorageTableRowByPartitionKeyRowKey -Table $Table -PartitionKey "partition1" -RowKey "id12345" -Top 10 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] [AllowEmptyString()] [string]$PartitionKey, [Parameter(Mandatory=$true)] [AllowEmptyString()] [string]$RowKey, [Parameter(Mandatory=$false)] [Nullable[Int32]]$Top = $null ) # Filtering by Partition Key and Row Key Write-Verbose $DeprecatedMessage -Verbose $Result = Get-AzTableRow -Table $Table -PartitionKey $PartitionKey -RowKey $RowKey -Top $Top if (-not [string]::IsNullOrEmpty($Result)) { return $Result } } function Get-AzTableRowByColumnName { <# .SYNOPSIS Returns one or more rows/entities based on a specified column and its value .DESCRIPTION Returns one or more rows/entities based on a specified column and its value .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities .PARAMETER ColumnName Column name to compare the value to .PARAMETER Value Value that will be looked for in the defined column .PARAMETER GuidValue Value that will be looked for in the defined column as Guid .PARAMETER Operator Supported comparison Operator. Valid values are "Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual" .PARAMETER Top Return only the first n rows from the query .EXAMPLE # Getting row by firstname Get-AzTableRowByColumnName -Table $Table -ColumnName "firstName" -value "Paulo" -Operator Equal .EXAMPLE # Getting row by firstname with a maximum number of rows returned Get-AzTableRowByColumnName -Table $Table -ColumnName "firstName" -value "Paulo" -Operator Equal -Top 10 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] [string]$ColumnName, [Parameter(ParameterSetName="byString",Mandatory=$true)] [AllowEmptyString()] [string]$Value, [Parameter(ParameterSetName="byGuid",Mandatory=$true)] [guid]$GuidValue, [Parameter(Mandatory=$true)] [validateSet("Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual")] [string]$Operator, [Parameter(Mandatory=$false)] [Nullable[Int32]]$Top = $null ) Write-Verbose $DeprecatedMessage -Verbose # Filtering by Columnn Name if ($PSCmdlet.ParameterSetName -eq "byString") { Get-AzTableRow -Table $Table -ColumnName $ColumnName -value $Value -Operator $Operator -Top $Top } else { Get-AzTableRow -Table $Table -ColumnName $ColumnName -GuidValue $GuidValue -Operator $Operator -Top $Top } if (-not [string]::IsNullOrEmpty($Result)) { return $Result } } function Get-AzTableRowByCustomFilter { <# .SYNOPSIS Returns one or more rows/entities based on custom Filter. .DESCRIPTION Returns one or more rows/entities based on custom Filter. This custom Filter can be built using the Microsoft.Azure.Cosmos.Table.TableQuery class or direct text. .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities .PARAMETER CustomFilter Custom Filter string. .PARAMETER Top Return only the first n rows from the query .EXAMPLE # Getting row by firstname by using the class Microsoft.Azure.Cosmos.Table.TableQuery $MyFilter = "(firstName eq 'User1')" Get-AzTableRowByCustomFilter -Table $Table -CustomFilter $MyFilter .EXAMPLE # Getting row by firstname by using text Filter directly (oData Filter format) Get-AzTableRowByCustomFilter -Table $Table -CustomFilter "(firstName eq 'User1') and (lastName eq 'LastName1')" .EXAMPLE # Getting row by firstname by using text Filter directly with a maximum number of rows returned Get-AzTableRowByCustomFilter -Table $Table -CustomFilter "(firstName eq 'User1') and (lastName eq 'LastName1')" -Top 10 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true)] [string]$CustomFilter, [Parameter(Mandatory=$false)] [Nullable[Int32]]$Top = $null ) Write-Verbose $DeprecatedMessage -Verbose # Custom Filter $Result = Get-AzTableRow -Table $Table -CustomFilter $CustomFilter -Top $Top if (-not [string]::IsNullOrEmpty($Result)) { return $Result } } function Get-AzTableRow { <# .SYNOPSIS Used to return entities from a table with several options, this replaces all other Get-AzTable<XYZ> cmdlets. .DESCRIPTION Used to return entities from a table with several options, this replaces all other Get-AzTable<XYZ> cmdlets. .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable to retrieve entities (common to all parameter sets) .PARAMETER PartitionKey Identifies the table partition (byPartitionKey and byPartRowKeys parameter sets) .PARAMETER RowKey Identifies the row key in the partition (byPartRowKeys parameter set) .PARAMETER SelectColumn Names of the properties to return for each entity .PARAMETER ColumnName Column name to compare the value to (byColummnString and byColummnGuid parameter sets) .PARAMETER Value Value that will be looked for in the defined column (byColummnString parameter set) .PARAMETER GuidValue Value that will be looked for in the defined column as Guid (byColummnGuid parameter set) .PARAMETER Operator Supported comparison Operator. Valid values are "Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual" (byColummnString and byColummnGuid parameter sets) .PARAMETER CustomFilter Custom Filter string (byCustomFilter parameter set) .PARAMETER Top Return only the first n rows from the query (all parameter sets) .EXAMPLE # Getting all rows Get-AzTableRow -Table $Table .EXAMPLE # Getting specific properties for all rows $columns = ('osVersion', 'computerName') Get-AzTableRow -Table $Table -SelectColumn $columns .EXAMPLE # Getting rows by partition key Get-AzTableRow -Table $table -partitionKey NewYorkSite .EXAMPLE # Getting rows by partition and row key Get-AzTableRow -Table $table -partitionKey NewYorkSite -rowKey "afc04476-bda0-47ea-a9e9-7c739c633815" .EXAMPLE # Getting rows by Columnm Name using Guid columns in table Get-AzTableRow -Table $Table -ColumnName "id" -guidvalue "5fda3053-4444-4d23-b8c2-b26e946338b6" -operator Equal .EXAMPLE # Getting rows by Columnm Name using string columns in table Get-AzTableRow -Table $Table -ColumnName "osVersion" -value "Windows NT 4" -operator Equal .EXAMPLE # Getting rows using Custom Filter Get-AzTableRow -Table $Table -CustomFilter "(osVersion eq 'Windows NT 4') and (computerName eq 'COMP07')" .EXAMPLE # Querying with a maximum number of rows returned Get-AzTableRow -Table $Table -partitionKey NewYorkSite -Top 10 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true,ParameterSetName="GetAll")] [Parameter(ParameterSetName="byPartitionKey")] [Parameter(ParameterSetName="byPartRowKeys")] [Parameter(ParameterSetName="byColummnString")] [Parameter(ParameterSetName="byColummnGuid")] [Parameter(ParameterSetName="byCustomFilter")] $Table, [Parameter(ParameterSetName="GetAll")] [Parameter(ParameterSetName="byPartitionKey")] [Parameter(ParameterSetName="byPartRowKeys")] [Parameter(ParameterSetName="byColummnString")] [Parameter(ParameterSetName="byColummnGuid")] [Parameter(ParameterSetName="byCustomFilter")] [System.Collections.Generic.List[string]]$SelectColumn, [Parameter(Mandatory=$true,ParameterSetName="byPartitionKey")] [Parameter(ParameterSetName="byPartRowKeys")] [AllowEmptyString()] [string]$PartitionKey, [Parameter(Mandatory=$true,ParameterSetName="byPartRowKeys")] [AllowEmptyString()] [string]$RowKey, [Parameter(Mandatory=$true, ParameterSetName="byColummnString")] [Parameter(ParameterSetName="byColummnGuid")] [string]$ColumnName, [Parameter(Mandatory=$true, ParameterSetName="byColummnString")] [AllowEmptyString()] [string]$Value, [Parameter(ParameterSetName="byColummnGuid",Mandatory=$true)] [guid]$GuidValue, [Parameter(Mandatory=$true, ParameterSetName="byColummnString")] [Parameter(ParameterSetName="byColummnGuid")] [validateSet("Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual")] [string]$Operator, [Parameter(Mandatory=$true, ParameterSetName="byCustomFilter")] [string]$CustomFilter, [Parameter(Mandatory=$false)] [Nullable[Int32]]$Top = $null ) $TableQuery = New-Object -TypeName "Microsoft.Azure.Cosmos.Table.TableQuery" # Building filters if any if ($PSCmdlet.ParameterSetName -eq "byPartitionKey") { [string]$Filter = ` [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("PartitionKey",` [Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,$PartitionKey) } elseif ($PSCmdlet.ParameterSetName -eq "byPartRowKeys") { [string]$FilterA = ` [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("PartitionKey",` [Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,$PartitionKey) [string]$FilterB = ` [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("RowKey",` [Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,$RowKey) [string]$Filter = [Microsoft.Azure.Cosmos.Table.TableQuery]::CombineFilters($FilterA,"and",$FilterB) } elseif ($PSCmdlet.ParameterSetName -eq "byColummnString") { [string]$Filter = ` [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition($ColumnName,[Microsoft.Azure.Cosmos.Table.QueryComparisons]::$Operator,$Value) } elseif ($PSCmdlet.ParameterSetName -eq "byColummnGuid") { [string]$Filter = ` [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterConditionForGuid($ColumnName,[Microsoft.Azure.Cosmos.Table.QueryComparisons]::$Operator,$GuidValue) } elseif ($PSCmdlet.ParameterSetName -eq "byCustomFilter") { [string]$Filter = $CustomFilter } else { [string]$filter = $null } # Adding filter if not null if (-not [string]::IsNullOrEmpty($Filter)) { $TableQuery.FilterString = $Filter } # Selecting columns if specified if ($null -ne $SelectColumn){ $TableQuery.SelectColumns = $SelectColumn } # Set number of rows to return. if ($null -ne $Top) { $TableQuery.TakeCount = $Top } # Getting results if (($TableQuery.FilterString -ne $null) -or ($PSCmdlet.ParameterSetName -eq "GetAll")) { $Result = ExecuteQueryAsync -Table $Table -TableQuery $TableQuery # if (-not [string]::IsNullOrEmpty($Result.Result.Results)) # { # return (GetPSObjectFromEntity($Result.Result.Results)) # } if (-not [string]::IsNullOrEmpty($Result)) { return (GetPSObjectFromEntity($Result)) } } } function Update-AzTableRow { <# .SYNOPSIS Updates a table entity .DESCRIPTION Updates a table entity. To work with this cmdlet, you need first retrieve an entity with one of the Get-AzTableRow cmdlets available and store in an object, change the necessary properties and then perform the update passing this modified entity back, through Pipeline or as argument. Notice that this cmdlet accepts only one entity per execution. This cmdlet cannot update Partition Key and/or RowKey because it uses those two values to locate the entity to update it, if this operation is required please delete the old entity and add the new one with the updated values instead. .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable where the entity exists .PARAMETER Entity The entity/row with new values to perform the update. .EXAMPLE # Updating an entity [string]$Filter = [Microsoft.Azure.Cosmos.Table.TableQuery]::GenerateFilterCondition("firstName",[Microsoft.Azure.Cosmos.Table.QueryComparisons]::Equal,"User1") $person = Get-AzTableRowByCustomFilter -Table $Table -CustomFilter $Filter $person.lastName = "New Last Name" $person | Update-AzTableRow -Table $Table #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true,ValueFromPipeline=$true)] $entity ) # Only one entity at a time can be updated $updatedEntityList = @() $updatedEntityList += $entity if ($updatedEntityList.Count -gt 1) { throw "Update operation can happen on only one entity at a time, not in a list/array of entities." } $updatedEntity = New-Object -TypeName "Microsoft.Azure.Cosmos.Table.DynamicTableEntity" -ArgumentList $entity.PartitionKey, $entity.RowKey # Iterating over PS Object properties to add to the updated entity foreach ($prop in $entity.psobject.Properties) { if (($prop.name -ne "PartitionKey") -and ($prop.name -ne "RowKey") -and ($prop.name -ne "Timestamp") -and ($prop.name -ne "Etag") -and ($prop.name -ne "TableTimestamp")) { $updatedEntity.Properties.Add($prop.name, $prop.Value) } } $updatedEntity.ETag = $entity.Etag $updatedEntity.Timestamp = $entity.TableTimestamp # Updating the dynamic table entity to the table # return ($Table.ExecuteAsync([Microsoft.Azure.Cosmos.Table.TableOperation]::InsertOrMerge($updatedEntity))) return ($Table.Execute([Microsoft.Azure.Cosmos.Table.TableOperation]::InsertOrMerge($updatedEntity))) } function Remove-AzTableRow { <# .SYNOPSIS Remove-AzTableRow - Removes a specified table row .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. .PARAMETER Table Table object of type Microsoft.Azure.Cosmos.Table.CloudTable where the entity exists .PARAMETER Entity (ParameterSetName=byEntityPSObjectObject) The entity/row with new values to perform the deletion. .PARAMETER PartitionKey (ParameterSetName=byPartitionandRowKeys) Partition key where the entity belongs to. .PARAMETER RowKey (ParameterSetName=byPartitionandRowKeys) Row key that uniquely identifies the entity within the partition. .EXAMPLE # 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 # Deleting an entry by using PartitionKey and row key directly Remove-AzTableRow -Table $Table -PartitionKey "TableEntityDemoFullList" -RowKey "399b58af-4f26-48b4-9b40-e28a8b03e867" .EXAMPLE # Deleting everything Get-AzTableRowAll -Table $Table | Remove-AzTableRow -Table $Table #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] $Table, [Parameter(Mandatory=$true,ValueFromPipeline=$true,ParameterSetName="byEntityPSObjectObject")] $entity, [Parameter(Mandatory=$true,ParameterSetName="byPartitionandRowKeys")] [AllowEmptyString()] [string]$PartitionKey, [Parameter(Mandatory=$true,ParameterSetName="byPartitionandRowKeys")] [AllowEmptyString()] [string]$RowKey ) begin { $updatedEntityList = @() $updatedEntityList += $entity if ($updatedEntityList.Count -gt 1) { throw "Delete operation cannot happen on an array of entities, altough you can pipe multiple items." } $Results = @() } process { if ($PSCmdlet.ParameterSetName -eq "byEntityPSObjectObject") { $PartitionKey = $entity.PartitionKey $RowKey = $entity.RowKey } $TableQuery = New-Object -TypeName "Microsoft.Azure.Cosmos.Table.TableQuery" [string]$Filter = "(PartitionKey eq '$($PartitionKey)') and (RowKey eq '$($RowKey)')" $TableQuery.FilterString = $Filter $itemToDelete = ExecuteQueryAsync -Table $Table -TableQuery $TableQuery if ($itemToDelete -ne $null) { # Converting DynamicTableEntity to TableEntity for deletion $entityToDelete = New-Object -TypeName "Microsoft.Azure.Cosmos.Table.TableEntity" $entityToDelete.ETag = $itemToDelete.Etag $entityToDelete.PartitionKey = $itemToDelete.PartitionKey $entityToDelete.RowKey = $itemToDelete.RowKey $Results += $Table.Execute([Microsoft.Azure.Cosmos.Table.TableOperation]::Delete($entityToDelete)) } } end { return ,$Results } } # Aliases If (-not (Get-Alias -Name Add-StorageTableRow -ErrorAction SilentlyContinue)) { New-Alias -Name Add-StorageTableRow -Value Add-AzTableRow } If (-not (Get-Alias -Name Add-AzureStorageTableRow -ErrorAction SilentlyContinue)) { New-Alias -Name Add-AzureStorageTableRow -Value Add-AzTableRow } If (-not (Get-Alias -Name Get-AzureStorageTableTable -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableTable -Value Get-AzTableTable } If (-not (Get-Alias -Name Get-AzureStorageTableRowAll -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRowAll -Value Get-AzTableRowAll } If (-not (Get-Alias -Name Get-AzureStorageTableRowByPartitionKey -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRowByPartitionKey -Value Get-AzTableRowByPartitionKey } If (-not (Get-Alias -Name Get-AzureStorageTableRowByPartitionKeyRowKey -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRowByPartitionKeyRowKey -Value Get-AzTableRowByPartitionKeyRowKey } If (-not (Get-Alias -Name Get-AzureStorageTableRowByColumnName -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRowByColumnName -Value Get-AzTableRowByColumnName } If (-not (Get-Alias -Name Get-AzureStorageTableRowByCustomFilter -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRowByCustomFilter -Value Get-AzTableRowByCustomFilter } If (-not (Get-Alias -Name Get-AzureStorageTableRow -ErrorAction SilentlyContinue)) { New-Alias -Name Get-AzureStorageTableRow -Value Get-AzTableRow } If (-not (Get-Alias -Name Update-AzureStorageTableRow -ErrorAction SilentlyContinue)) { New-Alias -Name Update-AzureStorageTableRow -Value Update-AzTableRow } If (-not (Get-Alias -Name Remove-AzureStorageTableRow -ErrorAction SilentlyContinue)) { New-Alias -Name Remove-AzureStorageTableRow -Value Remove-AzTableRow } |