AzStorageTableCoreHelper.psm1
|
<# .SYNOPSIS AzStorageTableCoreHelper.psm1 - PowerShell Module that contains all functions related to manipulating Azure Storage Table rows/entities. .DESCRIPTION AzStorageTableCoreHelper.psm1 - PowerShell Module that contains all functions related to manipulating Azure Storage Table rows/entities. .NOTES Make sure the latest Azure PowerShell module is installed since we have a dependency on Microsoft.WindowsAzure.Storage.dll and Microsoft.WindowsAzure.Commands.Common.Storage.dll. If running this module from Azure Automation, please make sure you check out this blog post for more information: https://blogs.technet.microsoft.com/paulomarques/2017/01/17/working-with-azure-storage-tables-from-powershell/ #> #Requires -Modules Az.Storage, Azure.Storage # Module Functions function GetLatestFullAssemblyName { param ( [string]$dllName ) # getting list of all assemblies $assemblies = [appdomain]::currentdomain.getassemblies() | Where-Object {$_.location -like "*$dllName"} if ($null -eq $assemblies) { throw "Could not identify any assembly related to DLL named $dllName" } $sanitazedAssemblyList = @() foreach ($assembly in $assemblies) { [version]$version = $assembly.fullname.split(",")[1].split("=")[1] $sanitazedAssemblyList += New-Object -TypeName psobject -Property @{"version" = $version; "fullName" = $assembly.fullname} } return ($sanitazedAssemblyList | Sort-Object version -Descending)[0] } # Getting latest Microsoft.WindowsAzure.Storage.dll full Assembly name $assemblySN = (GetLatestFullAssemblyName -dllName "Microsoft.WindowsAzure.Storage.dll").fullname $cloudTableType = [System.Type]::GetType("Microsoft.WindowsAzure.Storage.Table.CloudTable, $assemblySN") $tableQueryType = [System.Type]::GetType("Microsoft.WindowsAzure.Storage.Table.TableQuery, $assemblySN") $executeQuery = $cloudTableType.GetMethod("ExecuteQuery", @('instance', 'public', 'nonpublic'), $null, [type[]]@( $tableQueryType), $null) function Test-AzureStorageTableEmptyKeys { [CmdletBinding()] param ( [string]$partitionKey, [String]$rowKey ) $cosmosDBEmptyKeysErrorMessage = "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 $cosmosDBEmptyKeysErrorMessage } } function Get-AzStorageTableTable { <# .SYNOPSIS Gets a Table object, it can be from Azure Storage Table or Cosmos DB in preview support. .DESCRIPTION Gets a Table object, it can be from Azure Storage Table or Cosmos DB in preview support. .PARAMETER resourceGroup Resource Group where the Azure Storage Account or Cosmos DB are 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-AzStorageTableTable -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)] [Parameter(ParameterSetName = "AzClassicTableStorage", Mandatory = $true)] [String]$storageAccountName ) $nullTableErrorMessage = [string]::Empty switch ($PSCmdlet.ParameterSetName) { "AzTableStorage" { $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccountName).Context $nullTableErrorMessage = "Table $tableName could not be retrieved from Storage Account $storageAccountName on resource group $resourceGroupName" } "AzClassicTableStorage" { $saContext = New-AzStorageContext -ConnectionString (Get-AzureStorageAccount -StorageAccountName $storageAccountName).Context.ConnectionString $nullTableErrorMessage = "Table $tableName could not be retrieved from Classic Storage Account $storageAccountName" } } [Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable]$table = Get-AzStorageTable -Name $tableName -Context $saContext -ErrorAction SilentlyContinue # Creating a new table if one does not exist if ( $null -eq $table) { [Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable]$table = New-AzureStorageTable -Name $tableName -Context $saContext } # Checking if there a table got returned if ( $null -eq $table) { throw $nullTableErrorMessage } # Returns the table object return [Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable]$table } function Add-AzStorageTableRow { <# .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.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable 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 $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Add-AzStorageTableRow -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.WindowsAzure.Storage.Table.DynamicTableEntity,$assemblySN" -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.CloudTable.ExecuteAsync((invoke-expression "[Microsoft.WindowsAzure.Storage.Table.TableOperation,$assemblySN]::insertorreplace(`$entity)")).GetAwaiter().GetResult()) } else { return ($table.CloudTable.ExecuteAsync((invoke-expression "[Microsoft.WindowsAzure.Storage.Table.TableOperation,$assemblySN]::insert(`$entity)")).GetAwaiter().GetResult()) } } function Get-PSObjectFromEntity { # Internal function # Converts entities output from the ExecuteQuery method of table into an array of PowerShell Objects [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $entityList ) $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-AzStorageTableRowAll { <# .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.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable to retrieve entities .EXAMPLE # Getting all rows $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowAll -table $table #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $table ) # No filtering $tableQuery = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Table.TableQuery,$assemblySN" $result = $executeQuery.Invoke($table.CloudTable, $tableQuery) #$table.CloudTable.ExecuteQuery($tableQuery) if (-not [string]::IsNullOrEmpty($result)) { return (Get-PSObjectFromEntity -entityList $result) } } function Get-AzStorageTableRowByPartitionKey { <# .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.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable to retrieve entities .PARAMETER PartitionKey Identifies the table partition .EXAMPLE # Getting rows by partition Key $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowByPartitionKey -table $table -partitionKey $newPartitionKey #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $table, [Parameter(Mandatory = $true)] [AllowEmptyString()] [string]$partitionKey ) # Filtering by Partition Key $tableQuery = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Table.TableQuery,$assemblySN" [string]$filter = ` [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("PartitionKey", ` [Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal, $partitionKey) $tableQuery.FilterString = $filter #$result = $table.CloudTable.ExecuteQuery($tableQuery) $result = $executeQuery.Invoke($table.CloudTable, $tableQuery) if (-not [string]::IsNullOrEmpty($result)) { return (Get-PSObjectFromEntity -entityList $result) } } function Get-AzStorageTableRowByPartitionKeyRowKey { <# .SYNOPSIS Returns one entitie based on Partition Key and RowKey .DESCRIPTION Returns one entitie based on Partition Key and RowKey .PARAMETER Table Table object of type Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable to retrieve entities .PARAMETER PartitionKey Identifies the table partition .PARAMETER RowKey Identifies the row key in the partition .EXAMPLE # Getting rows by Partition Key and Row Key $saContext = (Get-AzureRmStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzureStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowByPartitionKeyRowKey -table $table -partitionKey $newPartitionKey -rowKey $newRowKey #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $table, [Parameter(Mandatory = $true)] [AllowEmptyString()] [string]$partitionKey, [Parameter(Mandatory = $true)] [AllowEmptyString()] [string]$rowKey ) # Filtering by Partition Key and Row Key $tableQuery = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Table.TableQuery,$assemblySN" [string]$filter1 = ` [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("PartitionKey", ` [Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal, $partitionKey) [string]$filter2 = ` [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("RowKey", ` [Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal, $rowKey) [string]$filter = [Microsoft.WindowsAzure.Storage.Table.TableQuery]::CombineFilters($filter1, "and", $filter2) $tableQuery.FilterString = $filter # $result = $table.CloudTable.ExecuteQuery($tableQuery) $result = $executeQuery.Invoke($table.CloudTable, $tableQuery) if (-not [string]::IsNullOrEmpty($result)) { return (Get-PSObjectFromEntity -entityList $result) } } function Get-AzStorageTableRowByColumnName { <# .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.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable 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 Operator Supported comparison operator. Valid values are "Equal","GreaterThan","GreaterThanOrEqual","LessThan" ,"LessThanOrEqual" ,"NotEqual" .EXAMPLE # Getting row by firstname $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowByColumnName -table $table -columnName "firstName" -value "Paulo" -operator Equal #> [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 ) # Filtering by Partition Key $tableQuery = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Table.TableQuery,$assemblySN" if ($PSCmdlet.ParameterSetName -eq "byString") { [string]$filter = ` [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition($columnName, [Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::$operator, $value) } if ($PSCmdlet.ParameterSetName -eq "byGuid") { [string]$filter = ` [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterConditionForGuid($columnName, [Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::$operator, $guidValue) } $tableQuery.FilterString = $filter #$result = $table.CloudTable.ExecuteQuery($tableQuery) $result = $executeQuery.Invoke($table.CloudTable, $tableQuery) if (-not [string]::IsNullOrEmpty($result)) { return (Get-PSObjectFromEntity -entityList $result) } } function Get-AzStorageTableRowByCustomFilter { <# .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.WindowsAzure.Storage.Table.TableQuery class or direct text. .PARAMETER Table Table object of type Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable to retrieve entities .PARAMETER customFilter Custom filter string. .EXAMPLE # Getting row by firstname by using the class Microsoft.WindowsAzure.Storage.Table.TableQuery $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowByCustomFilter -table $table -customFilter $finalFilter .EXAMPLE # Getting row by firstname by using text filter directly (oData filter format) $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowByCustomFilter -table $table -customFilter "(firstName eq 'User1') and (lastName eq 'LastName1')" #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] $table, [Parameter(Mandatory = $true)] [string]$customFilter ) # Filtering by Partition Key $tableQuery = New-Object -TypeName "Microsoft.WindowsAzure.Storage.Table.TableQuery,$assemblySN" $tableQuery.FilterString = $customFilter #$result = $table.CloudTable.ExecuteQuery($tableQuery) $result = $executeQuery.Invoke($table.CloudTable, $tableQuery) if (-not [string]::IsNullOrEmpty($result)) { return (Get-PSObjectFromEntity -entityList $result) } } function Update-AzStorageTableRow { <# .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-AzureStorageTableRow 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.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable where the entity exists .PARAMETER Entity The entity/row with new values to perform the update. .EXAMPLE # Updating an entity $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext [string]$filter = [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("firstName",[Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal,"User1") $person = Get-AzStorageTableRowByCustomFilter -table $table -customFilter $filter $person.lastName = "New Last Name" $person | Update-AzStorageTableRow -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.WindowsAzure.Storage.Table.DynamicTableEntity,$assemblySN" -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 # Updating the dynamic table entity to the table return ($table.CloudTable.ExecuteAsync((invoke-expression "[Microsoft.WindowsAzure.Storage.Table.TableOperation,$assemblySN]::Replace(`$updatedEntity)")).GetAwaiter().GetResult()) } function Remove-AzStorageTableRow { <# .SYNOPSIS Remove-AzStorageTableRow - Removes a specified table row .DESCRIPTION Remove-AzStorageTableRow - Removes a specified table row. It accepts multiple deletions through the Pipeline when passing entities returned from the Get-AzureStorageTableRow available cmdlets. It also can delete a row/entity using Partition and Row Key properties directly. .PARAMETER Table Table object of type Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable 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 $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext [string]$filter1 = [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("firstName",[Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal,"Paulo") [string]$filter2 = [Microsoft.WindowsAzure.Storage.Table.TableQuery]::GenerateFilterCondition("lastName",[Microsoft.WindowsAzure.Storage.Table.QueryComparisons]::Equal,"Marques") [string]$finalFilter = [Microsoft.WindowsAzure.Storage.Table.TableQuery]::CombineFilters($filter1,"and",$filter2) $personToDelete = Get-AzStorageTableRowByCustomFilter -table $table -customFilter $finalFilter $personToDelete | Remove-AzStorageTableRow -table $table .EXAMPLE # Deleting an entry by using partitionkey and row key directly $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Remove-AzStorageTableRow -table $table -partitionKey "TableEntityDemoFullList" -rowKey "399b58af-4f26-48b4-9b40-e28a8b03e867" .EXAMPLE # Deleting everything $saContext = (Get-AzStorageAccount -ResourceGroupName $resourceGroup -Name $storageAccount).Context $table = Get-AzStorageTable -Name $tableName -Context $saContext Get-AzStorageTableRowAll -table $table | Remove-AzureStorageTableRow -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 } $entityToDelete = invoke-expression "[Microsoft.WindowsAzure.Storage.Table.DynamicTableEntity,$assemblySN](`$table.CloudTable.ExecuteAsync([Microsoft.WindowsAzure.Storage.Table.TableOperation,$assemblySN]::Retrieve(`$partitionKey,`$rowKey))).GetAwaiter().GetResult().Result" if ($null -ne $entityToDelete ) { $results += $table.CloudTable.ExecuteAsync((invoke-expression "[Microsoft.WindowsAzure.Storage.Table.TableOperation,$assemblySN]::Delete(`$entityToDelete)")).GetAwaiter().GetResult() } } end { return , $results } } # Aliases #New-Alias -Name Add-AzureStorageTableRow -Value Add-StorageTableRow |