Az.Storage

1.2.1-preview

Microsoft.Azure.Commands.Management.Storage.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Invoke-AzStorageAccountFailover</command:name>

      <command:verb>Invoke</command:verb>

      <command:noun>AzStorageAccountFailover</command:noun>

      <maml:description>

        <maml:para>Invokes failover of a Storage account.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Invokes failover of a Storage account. Failover request can be triggered for a storage account in case of availability issues.  The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover. Please understand the following impact to your storage account before you initiate the failover: 1.1. Please check the Last Sync Time using GET Blob Service Stats (https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats), GET Table Service Stats (https://docs.microsoft.com/en-us/dotnet/api/microsoft.windowsazure.storage.table.cloudtableclient.getservicestats?view=azure-dotnet) and GET Queue Service Stats (https://docs.microsoft.com/en-us/dotnet/api/microsoft.windowsazure.storage.queue.cloudqueueclient.getservicestats?view=azure-dotnet) for your account. This is the data you may lose if you initiate the failover. 2.After the failover, your storage account type will be converted to locally redundant storage(LRS). You can convert your account to use geo-redundant storage(GRS). 3.Once you re-enable GRS for your storage account, Microsoft will replicate data to your new secondary region. Replication time is dependent on the amount of data to replicate. Please note that there are bandwidth charges for the bootstrap. https://azure.microsoft.com/en-us/pricing/details/bandwidth/</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-AzStorageAccountFailover</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>AsJob</maml:name>

          <maml:Description>

            <maml:para>Run cmdlet in the background</maml:para>

          </maml:Description>

          <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential">

          <maml:name>DefaultProfile</maml:name>

          <maml:Description>

            <maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Force</maml:name>

          <maml:Description>

            <maml:para>Force to Failover the Account</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:Description>

            <maml:para>Storage account object</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">

          <maml:name>Confirm</maml:name>

          <maml:Description>

            <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

          </maml:Description>

          <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">

          <maml:name>WhatIf</maml:name>

          <maml:Description>

            <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Invoke-AzStorageAccountFailover</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>ResourceGroupName</maml:name>

          <maml:Description>

            <maml:para>Resource Group Name.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="StorageAccountName, AccountName">

          <maml:name>Name</maml:name>

          <maml:Description>

            <maml:para>Storage Account Name.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>AsJob</maml:name>

          <maml:Description>

            <maml:para>Run cmdlet in the background</maml:para>

          </maml:Description>

          <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential">

          <maml:name>DefaultProfile</maml:name>

          <maml:Description>

            <maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Force</maml:name>

          <maml:Description>

            <maml:para>Force to Failover the Account</maml:para>

          </maml:Description>

          <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">

          <maml:name>Confirm</maml:name>

          <maml:Description>

            <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

          </maml:Description>

          <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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">

          <maml:name>WhatIf</maml:name>

          <maml:Description>

            <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>

          </maml:Description>

          <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>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>AsJob</maml:name>

        <maml:Description>

          <maml:para>Run cmdlet in the background</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential">

        <maml:name>DefaultProfile</maml:name>

        <maml:Description>

          <maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</command:parameterValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Force</maml:name>

        <maml:Description>

          <maml:para>Force to Failover the Account</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:Description>

          <maml:para>Storage account object</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount</command:parameterValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="StorageAccountName, AccountName">

        <maml:name>Name</maml:name>

        <maml:Description>

          <maml:para>Storage Account Name.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>ResourceGroupName</maml:name>

        <maml:Description>

          <maml:para>Resource Group Name.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">

        <maml:name>Confirm</maml:name>

        <maml:Description>

          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.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" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">

        <maml:name>WhatIf</maml:name>

        <maml:Description>

          <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.Management.Automation.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:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>------- Example 1: Invoke failover of a Storage account -------</maml:title>

        <dev:code>PS C:\&gt;$account = Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -IncludeGeoReplicationStats

PS C:\&gt;$account.GeoReplicationStats

Status LastSyncTime

------ ------------

Live   11/13/2018 2:44:22 AM

PS C:\&gt;$job = Invoke-AzStorageAccountFailover -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Force -AsJob

PS C:\&gt;$job | Wait-Job</dev:code>

        <dev:remarks>

          <maml:para>This command check the last sync time of a Storage account then invokes failover of it, the secondary cluster will become primary after failover. Since failover takes a long time, suggest to run it in the backend with -Asjob parameter, and then wait for the job complete.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version:</maml:linkText>

        <maml:uri>https://docs.microsoft.com/en-us/powershell/module/Az.storage/invoke-Azstorageaccountfailover</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>