AzureTableEntity.psm1-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> <!-- Module: AzureTableEntity Version: 0.1.0.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-AzureTableEntity</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureTableEntity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Search Azure Table entities by specifying a search string.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QueryString</maml:name> <maml:description> <maml:para>Specify the Azure table search query string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConvertDateTimeFields</maml:name> <maml:description> <maml:para>The search result returned is deserialized, therefore datetime fields are returned as strings. The default value is $false. If this property is set to $true, any datetime fields in the search result will be converted back to datetime type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GetAll</maml:name> <maml:description> <maml:para>By default, a query against the Table service may return a maximum of 1,000 items at one time and may execute for a maximum of five seconds. if there are more than 1,000 items in the search result or the search query runs over five seconds, set this parameter to $true in order to return all items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QueryString</maml:name> <maml:description> <maml:para>Specify the Azure table search query string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConvertDateTimeFields</maml:name> <maml:description> <maml:para>The search result returned is deserialized, therefore datetime fields are returned as strings. The default value is $false. If this property is set to $true, any datetime fields in the search result will be converted back to datetime type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GetAll</maml:name> <maml:description> <maml:para>By default, a query against the Table service may return a maximum of 1,000 items at one time and may execute for a maximum of five seconds. if there are more than 1,000 items in the search result or the search query runs over five seconds, set this parameter to $true in order to return all items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>QueryString</maml:name> <maml:description> <maml:para>Specify the Azure table search query string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ConvertDateTimeFields</maml:name> <maml:description> <maml:para>The search result returned is deserialized, therefore datetime fields are returned as strings. The default value is $false. If this property is set to $true, any datetime fields in the search result will be converted back to datetime type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>$false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>GetAll</maml:name> <maml:description> <maml:para>By default, a query against the Table service may return a maximum of 1,000 items at one time and may execute for a maximum of five seconds. if there are more than 1,000 items in the search result or the search query runs over five seconds, set this parameter to $true in order to return all items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>$true</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $StorageAccountName = 'teststorageaccount' $TableName = 'testtable' $StorageAccountAccessKey = '/xVNuA3NDVzenU0Hb+o8I6lPM7HOxH/IO/UB2TrN4GGU/wsaLOX0ekH8F6JldkYKEifHAWMa7KQFbogxsDkhkw==' #Search Azure table $StartUTCDate = Get-Date -year 2016 -Month 11 -day 27 -Hour 11 -Minute 0 -Second 0 -Millisecond 0 $strStartUTCDate = $StartUTCDate.ToString('yyyy-MM-ddTHH:mm:ss.fffZ') $QueryString = "(dtDate ge datetime'$strStartUTCDate') and (PartitionKey eq 'BulkTest1')" $SearchResult = Get-AzureTableEntity -StorageAccountName $StorageAccountName -StorageAccountAccessKey $StorageAccountAccessKey -TableName $TableName -QueryString $QueryString -ConvertDateTimeFields $true -GetAll $true</dev:code> <dev:remarks> <maml:para>Query Azure table by specifying storage account name, table name and storage account access key and get all search result (should result exceeds 1000 items). </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $AzureTable = Get-AutomationConnection 'TestTableConnection' #Search Azure table $StartUTCDate = Get-Date -year 2016 -Month 11 -day 27 -Hour 11 -Minute 0 -Second 0 -Millisecond 0 $strStartUTCDate = $StartUTCDate.ToString('yyyy-MM-ddTHH:mm:ss.fffZ') $QueryString = "(dtDate ge datetime'$strStartUTCDate') and (PartitionKey eq 'BulkTest1')" $SearchResult = Get-AzureTableEntity -TableConnection $AzureTable -QueryString $QueryString -ConvertDateTimeFields $true -GetAll $false</dev:code> <dev:remarks> <maml:para>Query Azure table by specifying the automation connection and return up to 1000 results. </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-AzureTableEntity</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureTableEntity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Insert one or more entities to Azure table storage.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be inserted into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be inserted into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be inserted into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $StorageAccountName = 'teststorageaccount' $TableName = 'testtable' $StorageAccountAccessKey = '/xVNuA3NDVzenU0Hb+o8I6lPM7HOxH/IO/UB2TrN4GGU/wsaLOX0ekH8F6JldkYKEifHAWMa7KQFbogxsDkhkw==' #Insert into Azure table $properties = @{ PartitionKey = 'test2' RowKey = '1' CustomerName = 'Bart' HourlyRate = 9.99 today = [datetime]::UtcNow } $Entity = New-Object psobject -Property $properties $SingleInsert = New-AzureTableEntity -StorageAccountName $StorageAccountName -StorageAccountAccessKey $StorageAccountAccessKey -TableName $TableName -Entities $Entity</dev:code> <dev:remarks> <maml:para>Insert a single entity by specifying storage account name, table name and storage account access key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $AzureTable = Get-AutomationConnection 'TestTableConnection' #Insert multiple entities into Azure table $Entities = @() $pro1 = @{ PartitionKey = 'test1' RowKey = '1' CustomerName = 'Eric Cartman' dtDate = [datetime]::UtcNow Age = 9 Alive = $true } $entity1 = New-Object psobject -Property $pro1 $pro2 = @{ PartitionKey = 'test1' RowKey = '2' CustomerName = 'Bart Simpson' dtDate = [datetime]::UtcNow Age = 10 Alive = $true } $entity2 = New-Object psobject -Property $pro2 $Entities += $entity1 $Entities += $entity2 $BulkInsert = New-AzureTableEntity -TableConnection $AzureTable -Entities $Entities</dev:code> <dev:remarks> <maml:para>Insert multiple entities by specifying automation connection.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Remove-AzureTableEntity</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureTableEntity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove one or more entities from Azure table storage.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be removed into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100. Although you may add additional properties, only the PartitionKey and the RowKey are required in psobject. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be removed into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100. Although you may add additional properties, only the PartitionKey and the RowKey are required in psobject. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be removed into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100. Although you may add additional properties, only the PartitionKey and the RowKey are required in psobject. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $StorageAccountName = 'teststorageaccount' $TableName = 'testtable' $StorageAccountAccessKey = '/xVNuA3NDVzenU0Hb+o8I6lPM7HOxH/IO/UB2TrN4GGU/wsaLOX0ekH8F6JldkYKEifHAWMa7KQFbogxsDkhkw==' #Remove a single entity from Azure table $properties = @{ PartitionKey = 'test2' RowKey = '1' } $Entity = New-Object psobject -Property $properties SingleRemoval= Remove-AzureTableEntity -StorageAccountName $StorageAccountName -StorageAccountAccessKey $StorageAccountAccessKey -TableName $TableName -Entities $Entity</dev:code> <dev:remarks> <maml:para>Remove a single entity by specifying storage account name, table name and storage account access key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $AzureTable = Get-AutomationConnection 'TestTableConnection' #Remove multiple entities from Azure table $Entities = @() $pro1 = @{ PartitionKey = 'test1' RowKey = '1' } $entity1 = New-Object psobject -Property $pro1 $pro2 = @{ PartitionKey = 'test1' RowKey = '2' } $entity2 = New-Object psobject -Property $pro2 $Entities += $entity1 $Entities += $entity2 $BulkRemoval = Remove-AzureTableEntity -TableConnection $AzureTable -Entities $Entities</dev:code> <dev:remarks> <maml:para>Remove multiple entities by specifying automation connection.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Update-AzureTableEntity</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Update</command:verb> <command:noun>AzureTableEntity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Update one or more entities in Azure table storage.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be updated into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-AzureTableEntity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be updated into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableConnection</maml:name> <maml:description> <maml:para>Specify a AzureTable Automation connection object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Entities</maml:name> <maml:description> <maml:para>Specify a psobject or an array of psobject that represents the entities to be updated into Azure table. Each entity must contain "PartitionKey" and "RowKey" properties and the type of the value of these properties must be string. When specifying an array, the maximum size of the array must be no more than 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specify the Azure Storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>StorageAccountAccessKey</maml:name> <maml:description> <maml:para>Specify the Azure Storage account access key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specify the Azure Table name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $StorageAccountName = 'teststorageaccount' $TableName = 'testtable' $StorageAccountAccessKey = '/xVNuA3NDVzenU0Hb+o8I6lPM7HOxH/IO/UB2TrN4GGU/wsaLOX0ekH8F6JldkYKEifHAWMa7KQFbogxsDkhkw==' #Insert into Azure table $properties = @{ PartitionKey = 'test2' RowKey = '1' CustomerName = 'Bart' HourlyRate = 9.99 today = [datetime]::UtcNow } $Entity = New-Object psobject -Property $properties $SingleUpdate = Update-AzureTableEntity -StorageAccountName $StorageAccountName -StorageAccountAccessKey $StorageAccountAccessKey -TableName $TableName -Entities $Entity</dev:code> <dev:remarks> <maml:para>Update a single entity by specifying storage account name, table name and storage account access key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>#Azure table details $AzureTable = Get-AutomationConnection 'TestTableConnection' #Insert multiple entities into Azure table $Entities = @() $pro1 = @{ PartitionKey = 'test1' RowKey = '1' CustomerName = 'Eric Cartman' dtDate = [datetime]::UtcNow Age = 9 Alive = $true } $entity1 = New-Object psobject -Property $pro1 $pro2 = @{ PartitionKey = 'test1' RowKey = '2' CustomerName = 'Bart Simpson' dtDate = [datetime]::UtcNow Age = 10 Alive = $true } $entity2 = New-Object psobject -Property $pro2 $Entities += $entity1 $Entities += $entity2 $BulkUpdate = Update-AzureTableEntity -TableConnection $AzureTable -Entities $Entities</dev:code> <dev:remarks> <maml:para>Update multiple entities by specifying automation connection.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> </helpItems> |