en-US/AzBobbyTables.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Add-AzDataTableEntity --> <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:details> <command:name>Add-AzDataTableEntity</command:name> <command:verb>Add</command:verb> <command:noun>AzDataTableEntity</command:noun> <maml:description> <maml:para>Add one or more entities to an Azure Table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add an entity to an Azure Table, as a PSCustomObject.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ConnectionString --> <command:syntaxItem> <maml:name>Add-AzDataTableEntity</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UpdateExisting"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites provided entities if they exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SAS --> <command:syntaxItem> <maml:name>Add-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UpdateExisting"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites provided entities if they exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Key --> <command:syntaxItem> <maml:name>Add-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UpdateExisting"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites provided entities if they exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Row</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entry</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Property</maml:name> <maml:description> <maml:para>The entities to add to the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UpdateExisting"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites provided entities if they exist.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="UpdateExisting"> <maml:name>UpdateExisting</maml:name> <maml:description> <maml:para>Overwrites provided entities if they exist.</maml:para> <maml:para>This is an alias of the Force parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SAS</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> <maml:para>This is an alias of the SharedAccessSignature parameter.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities to add to the table.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$User = [pscustomobject]@{ FirstName = 'Bobby'; LastName = 'Tables'; PartitionKey = 'Example'; RowKey = '1' }</dev:code> <dev:remarks> <maml:para>Add the user "Bobby Tables" to the table using a shared access signature URL.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-AzDataTableEntity --> <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:details> <command:name>Get-AzDataTableEntity</command:name> <command:verb>Get</command:verb> <command:noun>AzDataTableEntity</command:noun> <maml:description> <maml:para>Get one or more entities from an Azure Table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get either all entities from an Azure Table, or those matching a provided OData filter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ConnectionString --> <command:syntaxItem> <maml:name>Get-AzDataTableEntity</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Query"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SAS --> <command:syntaxItem> <maml:name>Get-AzDataTableEntity</maml:name> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Query"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Key --> <command:syntaxItem> <maml:name>Get-AzDataTableEntity</maml:name> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Query"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Query"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Query"> <maml:name>Query</maml:name> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> <maml:para>This is an alias of the Filter parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SAS</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> <maml:para>This is an alias of the SharedAccessSignature parameter.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The OData filter to use in the query.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$UserEntity = Get-AzDataTableEntity -Filter "FirstName eq 'Bobby' and LastName eq 'Tables'" -TableName $TableName -ConnectionString $ConnectionString</dev:code> <dev:remarks> <maml:para>Get the user "Bobby Tables" from the table using a connection string.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Documentation on querying tables and entities.</maml:linkText> <maml:uri>https://docs.microsoft.com/en-gb/rest/api/storageservices/querying-tables-and-entities</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-AzDataTableEntity --> <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:details> <command:name>Remove-AzDataTableEntity</command:name> <command:verb>Remove</command:verb> <command:noun>AzDataTableEntity</command:noun> <maml:description> <maml:para>Remove one or more entities from an Azure Table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove one or more entities from an Azure Table, based on PartitionKey and RowKey.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ConnectionString --> <command:syntaxItem> <maml:name>Remove-AzDataTableEntity</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SAS --> <command:syntaxItem> <maml:name>Remove-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Key --> <command:syntaxItem> <maml:name>Remove-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Row</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entry</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Property</maml:name> <maml:description> <maml:para>The entities to remove from the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SAS</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> <maml:para>This is an alias of the SharedAccessSignature parameter.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities to remove from the table.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$UserEntity = Get-AzDataTableEntity -Filter "FirstName eq 'Bobby' and LastName eq 'Tables'" -TableName $TableName -ConnectionString $ConnectionString</dev:code> <dev:remarks> <maml:para>Get the user "Bobby Tables" from the table using a connection string, then remove the user using the storage account name and an access key.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-AzDataTableEntity --> <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:details> <command:name>Update-AzDataTableEntity</command:name> <command:verb>Update</command:verb> <command:noun>AzDataTableEntity</command:noun> <maml:description> <maml:para>Update one or more entities in an Azure Table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update one or more entities already existing in an Azure Table. For adding and overwriting, see the command Add-AzDataTableEntity.</maml:para> <maml:para>The PartitionKey and RowKey cannot be updated.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ConnectionString --> <command:syntaxItem> <maml:name>Update-AzDataTableEntity</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SAS --> <command:syntaxItem> <maml:name>Update-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Key --> <command:syntaxItem> <maml:name>Update-AzDataTableEntity</maml:name> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Entity --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entity</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Row</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Entry</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Row,Entry,Property"> <maml:name>Property</maml:name> <maml:description> <maml:para>The entities to update in the table.</maml:para> <maml:para>This is an alias of the Entity parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>The name of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection string to the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAccountKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account access key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedAccessSignature --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SharedAccessSignature</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SAS"> <maml:name>SAS</maml:name> <maml:description> <maml:para>The table service SAS URL.</maml:para> <maml:para>The table endpoint of the storage account, with the shared access token token appended to it.</maml:para> <maml:para>This is an alias of the SharedAccessSignature parameter.</maml:para> </maml:description> <command:parameterValue required="true">Uri</command:parameterValue> <dev:type> <maml:name>System.Uri</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities to update in the table.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$UserEntity = Get-AzDataTableEntity -Filter "FirstName eq 'Bobby'" -TableName $TableName -ConnectionString $ConnectionString</dev:code> <dev:remarks> <maml:para>Update the last name of the user "Bobby" to "Tables" using a connection string.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |