AzureSqlMaintenancePlan

0.0.54

AzureSqlMaintenancePlan.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>AzureSqlMaintenancePlan</name>

    </assembly>

    <members>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.CompressDatabaseCmdlet">

            <summary>

            <para type="synopsis">Compress a database</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetPlanSettingCmdlet">

            <summary>

            <para type="synopsis">Get plan setting</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetPlanCmdlet">

            <summary>

            <para type="synopsis">Get plan</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.SetPlanCmdlet">

            <summary>

            <para type="synopsis">Set plan</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.NewPlanCmdlet">

            <summary>

            <para type="synopsis">New plan</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.UnregisterStoreCmdlet">

            <summary>

            <para type="synopsis">Unregister store</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.RegisterStoreCmdlet">

            <summary>

            <para type="synopsis">Register store</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetElasticPoolCmdlet">

            <summary>

            <para type="synopsis">Get elastic pool</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetTableCmdlet">

            <summary>

            <para type="synopsis">Get tables information</para>

            </summary>

        </member>

        <member name="P:AzureSqlMaintenancePlan.Cmdlets.DatabaseCmdletBase.ConnectionString">

            <summary>

            <para type="description">Required data for connect to a database</para>

            </summary>

        </member>

        <member name="P:AzureSqlMaintenancePlan.Cmdlets.DatabasePSCmdletBase.ConnectionString">

            <summary>

            <para type="description">Required data for connect to a database</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetDatabaseCmdlet">

            <summary>

            <para type="synopsis">Get database</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.SetDatabaseCmdlet">

            <summary>

            <para type="synopsis">Set Azure sql database</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetConnectionStringCmdlet">

            <summary>

            <para type="synopsis">Get connection string</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetStatisticCmdlet">

            <summary>

            <para type="synopsis">Get statistics information</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.GetIndexCmdlet">

            <summary>

            <para type="synopsis">Get index information</para>

            <para type="description">This cmdlet allows you to retrieve index information.</para>

            <para type="link" uri="https://docs.microsoft.com/en-us/sql/relational-databases/indexes/reorganize-and-rebuild-indexes?view=sql-server-ver15#detecting-fragmentation-of-rowstore-indexes">Detecting fragmentation of rowstore indexes</para>

            <example>

            <code>

            <para>

            A very basic example

            </para>

            $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force

            $connectionString = New-Object AzureSqlMaintenancePlan.ConnectionString(".", "Northwind", "sa", $password)

            Get-Indexes -ConnectionString $connectionString

            </code>

            </example>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.UpdateStatisticCmdlet">

            <summary>

            <para type="synopsis">Update a statistic</para>

            </summary>

        </member>

        <member name="T:AzureSqlMaintenancePlan.Cmdlets.UpdateIndexCmdlet">

            <summary>

            <para type="synopsis">Update an index</para>

            </summary>

        </member>

        <member name="T:System.Security.SecureStringExtensions">

            <summary>

            Extends SecureString and string to convert from one to the other

            </summary>

            <remarks>https://github.com/Azure/azure-powershell/blob/master/src/KeyVault/KeyVault/Models/SecureStringExtensions.cs</remarks>

        </member>

        <member name="M:System.Security.SecureStringExtensions.ConvertToSecureString(System.String)">

            <summary>

            Converts a string into a secure string.

            </summary>

            <param name="value">the string to be converted.</param>

            <returns>The secure string converted from the input string </returns>

        </member>

        <member name="M:System.Security.SecureStringExtensions.ConvertToString(System.Security.SecureString)">

            <summary>

            Converts the secure string to a string.

            </summary>

            <param name="secureString">the secure string to be converted.</param> 

            <returns>The string converted from a secure string </returns>

        </member>

    </members>

</doc>