ÿþ<html> <head> <title>Get-SqlSynonym</title> </head> <body> <h1>Get-SqlSynonym</h1> <div>Gets an SMO Synonym object.</div> <h2> Syntax </h2> <code>Get-SqlSynonym [-database] &lt;Database&gt; [[-name] &lt;String&gt;] [&lt;CommonParameters&gt;]</code> <h2> Detailed Description </h2> <div> The Get-SqlSynonym function gets a collection of SMO Synonym objects for the specified database. </div> <h2> Related Commands </h2> <div> * <a href='Get-SqlSynonym.htm'>Get-SqlSynonym</a><br/> </div> <h2> Parameters </h2> <table border='1'> <tr> <th>Name</th> <th>Description</th> <th>Required?</th> <th>Pipeline Input</th> <th>Default Value</th> </tr> <tr valign='top'> <td>database&nbsp;</td> <td>&nbsp;</td> <td>true&nbsp;</td> <td>true (ByValue)&nbsp;</td> <td>&nbsp;</td> </tr> <tr valign='top'> <td>name&nbsp;</td> <td>&nbsp;</td> <td>false&nbsp;</td> <td>false&nbsp;</td> <td>&nbsp;</td> </tr> </table> <h2> Input Type </h2> <div>Microsoft.SqlServer.Management.Smo.Database You can pipe SMO database objects to Get-SqlSynonym</div> <h2> Return Values </h2> <div>Microsoft.SqlServer.Management.Smo.Synonym Get-SqlSynonym returns a Microsoft.SqlServer.Management.Smo.Synonym object.</div> <h2> Notes </h2> <div>Additional properties including the database, server and extended properties are included in the output.</div> <h2> Examples </h2> <h3> EXAMPLE 1</h3> <pre>Get-SqlSynonym $(Get-SqlDatabase "Z002\sql2K8" AdventureWorks)</pre> <div>This command gets a collection of SMO Synonym objects for SQL Server Z002\SQL2K8, AdventureWorks database.</div> <h3> EXAMPLE 2</h3> <pre>Get-SqlDatabase "Z002\sql2K8" | Get-SqlSynonym</pre> <div>This command gets a collection of SMO Synonym objects for all user databases on SQL Server Z002\SQL2K8.</div> <h3> EXAMPLE 3</h3> <pre>Get-SqlDatabase "Z002\sql2K8" AdventureWorks | Get-SqlSynonym -name "GrossRevenue"</pre> <div>This command gets an SMO Synonym object for the GrossRevenue synonym in the AdventureWorks database on SQL Server Z002\SQL2K8.</div> </body> </html>