Az.Sftp

0.3.0

Microsoft.Azure.PowerShell.Cmdlets.Sftp.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>Connect-AzSftp</command:name>

      <command:verb>Connect</command:verb>

      <command:noun>AzSftp</command:noun>

      <maml:description>

        <maml:para>Starts an interactive SFTP session to an Azure Storage Account. Users can login using Microsoft Entra accounts, or local user accounts via standard SSH authentication. Use Microsoft Entra account login for the best security and convenience.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Start interactive SFTP session to an Azure Storage Account. Users can login using Microsoft Entra issued certificates or using local user credentials. We recommend login using Microsoft Entra issued certificates when possible. The target storage account must have SFTP enabled and hierarchical namespace (HNS) enabled. For Microsoft Entra authentication, your Microsoft Entra identity must have appropriate RBAC permissions such as Storage Blob Data Contributor or Storage Blob Data Owner.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Connect-AzSftp</maml:name>

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

          <maml:name>StorageAccount</maml:name>

          <maml:description>

            <maml:para>Name of the target Azure Storage Account.</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>BufferSizeInBytes</maml:name>

          <maml:description>

            <maml:para>Buffer size in bytes for SFTP file transfers. Default: 262144 (256 KB).</maml:para>

          </maml:description>

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

          <dev:type>

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

            <maml:uri />

          </dev:type>

          <dev:defaultValue>262144</dev:defaultValue>

        </command:parameter>

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

          <maml:name>CertificateFile</maml:name>

          <maml:description>

            <maml:para>SSH Certificate to be used to authenticate to local user account.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="none">

          <maml:name>Port</maml:name>

          <maml:description>

            <maml:para>Port to connect to on the remote host.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Nullable`1[System.Int32]</command:parameterValue>

          <dev:type>

            <maml:name>System.Nullable`1[System.Int32]</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>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>PublicKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to public key file.</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>SftpArg</maml:name>

          <maml:description>

            <maml:para>Additional SFTP arguments passed to OpenSSH.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen, sftp).</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>StorageAccountEndpoint</maml:name>

          <maml:description>

            <maml:para>Custom storage account endpoint suffix. Default: Uses endpoint based on Azure environment (e.g., blob.core.windows.net).</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>

          <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>Connect-AzSftp</maml:name>

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

          <maml:name>StorageAccount</maml:name>

          <maml:description>

            <maml:para>Name of the target Azure Storage Account.</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>BufferSizeInBytes</maml:name>

          <maml:description>

            <maml:para>Buffer size in bytes for SFTP file transfers. Default: 262144 (256 KB).</maml:para>

          </maml:description>

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

          <dev:type>

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

            <maml:uri />

          </dev:type>

          <dev:defaultValue>262144</dev:defaultValue>

        </command:parameter>

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

          <maml:name>CertificateFile</maml:name>

          <maml:description>

            <maml:para>SSH Certificate to be used to authenticate to local user account.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="none">

          <maml:name>Port</maml:name>

          <maml:description>

            <maml:para>Port to connect to on the remote host.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Nullable`1[System.Int32]</command:parameterValue>

          <dev:type>

            <maml:name>System.Nullable`1[System.Int32]</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

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

          <maml:name>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>SftpArg</maml:name>

          <maml:description>

            <maml:para>Additional SFTP arguments passed to OpenSSH.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen, sftp).</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>StorageAccountEndpoint</maml:name>

          <maml:description>

            <maml:para>Custom storage account endpoint suffix. Default: Uses endpoint based on Azure environment (e.g., blob.core.windows.net).</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>

          <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>Connect-AzSftp</maml:name>

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

          <maml:name>StorageAccount</maml:name>

          <maml:description>

            <maml:para>Name of the target Azure Storage Account.</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>BufferSizeInBytes</maml:name>

          <maml:description>

            <maml:para>Buffer size in bytes for SFTP file transfers. Default: 262144 (256 KB).</maml:para>

          </maml:description>

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

          <dev:type>

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

            <maml:uri />

          </dev:type>

          <dev:defaultValue>262144</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="none">

          <maml:name>LocalUser</maml:name>

          <maml:description>

            <maml:para>Username for a local user in the target storage account.</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>Port</maml:name>

          <maml:description>

            <maml:para>Port to connect to on the remote host.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Nullable`1[System.Int32]</command:parameterValue>

          <dev:type>

            <maml:name>System.Nullable`1[System.Int32]</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>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>SftpArg</maml:name>

          <maml:description>

            <maml:para>Additional SFTP arguments passed to OpenSSH.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen, sftp).</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>StorageAccountEndpoint</maml:name>

          <maml:description>

            <maml:para>Custom storage account endpoint suffix. Default: Uses endpoint based on Azure environment (e.g., blob.core.windows.net).</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>

          <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>Connect-AzSftp</maml:name>

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

          <maml:name>StorageAccount</maml:name>

          <maml:description>

            <maml:para>Name of the target Azure Storage Account.</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>BufferSizeInBytes</maml:name>

          <maml:description>

            <maml:para>Buffer size in bytes for SFTP file transfers. Default: 262144 (256 KB).</maml:para>

          </maml:description>

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

          <dev:type>

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

            <maml:uri />

          </dev:type>

          <dev:defaultValue>262144</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="none">

          <maml:name>Port</maml:name>

          <maml:description>

            <maml:para>Port to connect to on the remote host.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">System.Nullable`1[System.Int32]</command:parameterValue>

          <dev:type>

            <maml:name>System.Nullable`1[System.Int32]</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

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

          <maml:name>PublicKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to public key file.</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>SftpArg</maml:name>

          <maml:description>

            <maml:para>Additional SFTP arguments passed to OpenSSH.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen, sftp).</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>StorageAccountEndpoint</maml:name>

          <maml:description>

            <maml:para>Custom storage account endpoint suffix. Default: Uses endpoint based on Azure environment (e.g., blob.core.windows.net).</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>

          <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>BufferSizeInBytes</maml:name>

        <maml:description>

          <maml:para>Buffer size in bytes for SFTP file transfers. Default: 262144 (256 KB).</maml:para>

        </maml:description>

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

        <dev:type>

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

          <maml:uri />

        </dev:type>

        <dev:defaultValue>262144</dev:defaultValue>

      </command:parameter>

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

        <maml:name>CertificateFile</maml:name>

        <maml:description>

          <maml:para>SSH Certificate to be used to authenticate to local user account.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="none">

        <maml:name>LocalUser</maml:name>

        <maml:description>

          <maml:para>Username for a local user in the target storage account.</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>Port</maml:name>

        <maml:description>

          <maml:para>Port to connect to on the remote host.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">System.Nullable`1[System.Int32]</command:parameterValue>

        <dev:type>

          <maml:name>System.Nullable`1[System.Int32]</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>PrivateKeyFile</maml:name>

        <maml:description>

          <maml:para>Path to private key file.</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>PublicKeyFile</maml:name>

        <maml:description>

          <maml:para>Path to public key file.</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>SftpArg</maml:name>

        <maml:description>

          <maml:para>Additional SFTP arguments passed to OpenSSH.</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>SshClientFolder</maml:name>

        <maml:description>

          <maml:para>Directory containing SSH executables (ssh-keygen, sftp).</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>StorageAccount</maml:name>

        <maml:description>

          <maml:para>Name of the target Azure Storage Account.</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>StorageAccountEndpoint</maml:name>

        <maml:description>

          <maml:para>Custom storage account endpoint suffix. Default: Uses endpoint based on Azure environment (e.g., blob.core.windows.net).</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>System.Diagnostics.Process</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: Connect to Azure Storage Account using Microsoft Entra issued certificates</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount"</dev:code>

        <dev:remarks>

          <maml:para>When a -LocalUser is not supplied, the cmdlet will attempt to login using Microsoft Entra ID. This is the recommended approach as it requires no manual certificate management.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 2: Connect to Local User on Azure Storage Account using SSH private key for authentication</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -LocalUser "sftpuser" -PrivateKeyFile "./id_rsa"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 3: Connect to Local User on Azure Storage Account using SSH private key for authentication</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -LocalUser "sftpuser" -PrivateKeyFile "./id_rsa"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 4: Connect to Local User on Azure Storage Account using interactive username and password authentication</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -LocalUser "sftpuser"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>---- Example 5: Connect with custom port and verbose output ----</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -Port 2022 -SftpArg "-v"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------------ Example 6: Connect with batch commands ------------</maml:title>

        <dev:code># Create batch file with SFTP commands

@"

cd uploads

put C:\local\file.txt

ls -la

quit

"@ | Out-File -FilePath "C:\temp\batch.sftp" -Encoding ([System.Text.Encoding]::ASCII)

# Execute batch commands

Connect-AzSftp -StorageAccount "mystorageaccount" -SftpArg "-b", "C:\temp\batch.sftp"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------ Example 7: Connect with custom SSH client location ------</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -SshClientFolder "C:\Program Files\OpenSSH"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>--------- Example 8: Connect with advanced SSH options ---------</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -SftpArg "-o", "ConnectTimeout=30", "-o", "StrictHostKeyChecking=no", "-v"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-- Example 9: Connect with certificate from existing SSH keys --</maml:title>

        <dev:code># Use existing SSH keys to generate a certificate automatically

Connect-AzSftp -StorageAccount "mystorageaccount" -PrivateKeyFile "C:\keys\id_rsa" -PublicKeyFile "C:\keys\id_rsa.pub"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------- Example 10: Troubleshoot authentication issues --------</maml:title>

        <dev:code># Check Microsoft Entra authentication status

Get-AzContext

# Test certificate generation explicitly

$cert = New-AzSftpCertificate -CertificatePath "C:\temp\test-cert.pub"

Write-Host "Certificate generated: $($cert.CertificatePath)"

Write-Host "Principal: $($cert.Principal)"

# Connect using the generated certificate

Connect-AzSftp -StorageAccount "mystorageaccount" -CertificateFile $cert.CertificatePath -PrivateKeyFile $cert.PrivateKeyPath -SftpArg "-v"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------- Example 11: Full workflow example --------------</maml:title>

        <dev:code># Generate certificate for SFTP authentication

$cert = New-AzSftpCertificate -CertificatePath "C:\certs\sftp-auth.cert"

# Connect to storage account using the generated certificate

$sftpProcess = Connect-AzSftp -StorageAccount "mystorageaccount" -CertificateFile $cert.CertificatePath -PrivateKeyFile $cert.PrivateKeyPath

# Display connection information

Write-Host "SFTP connection established using certificate: $($cert.CertificatePath)"

Write-Host "Process ID: $($sftpProcess.Id)"</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------- Example 12: Connect to multiple storage accounts -------</maml:title>

        <dev:code># Array of storage accounts to connect to

$storageAccounts = @("account1", "account2", "account3")

# Generate a certificate once for reuse

$cert = New-AzSftpCertificate -CertificatePath "C:\certs\shared-cert.cert"

# Connect to each storage account

foreach ($account in $storageAccounts) {

    Write-Host "Connecting to $account..."

    $process = Connect-AzSftp -StorageAccount $account -CertificateFile $cert.CertificatePath -PrivateKeyFile $cert.PrivateKeyPath -SftpArg "-b", "C:\scripts\sftp-commands.txt"

    Write-Host "Connected to $account (Process ID: $($process.Id))"

}</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 13: Connect using existing certificate and private key</maml:title>

        <dev:code>Connect-AzSftp -StorageAccount "mystorageaccount" -CertificateFile "C:\certs\azure-sftp.cert" -PrivateKeyFile "C:\certs\azure-sftp-key"</dev:code>

        <dev:remarks>

          <maml:para></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://learn.microsoft.com/powershell/module/az.sftp/connect-azsftp</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>New-AzSftpCertificate</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Azure Storage SFTP Support</maml:linkText>

        <maml:uri>https://docs.microsoft.com/en-us/azure/storage/blobs/secure-file-transfer-protocol-support</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Az.Storage Module</maml:linkText>

        <maml:uri>https://learn.microsoft.com/en-us/powershell/module/az.storage/</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

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

    <command:details>

      <command:name>New-AzSftpCertificate</command:name>

      <command:verb>New</command:verb>

      <command:noun>AzSftpCertificate</command:noun>

      <maml:description>

        <maml:para>Generate SSH certificates for SFTP authentication using Microsoft Entra credentials.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The New-AzSftpCertificate cmdlet generates SSH certificates for SFTP authentication using your current Microsoft Entra credentials. This cmdlet provides the same authentication methods and parameter sets as the Az.Ssh module, ensuring consistency across Azure PowerShell modules.</maml:para>

      <maml:para>The cmdlet supports four authentication modes that align with the SSH module: Default Mode (Microsoft Entra Authentication) : When no specific key files are provided, the cmdlet automatically generates a new SSH key pair and creates a certificate signed by Microsoft Entra's trusted CA. This is the simplest approach for getting started with SFTP authentication. FromPublicKey Mode : When a public key file is provided, the cmdlet generates a certificate for that specific key using Microsoft Entra credentials. This is useful when you already have SSH public keys and want to use them for Azure Storage SFTP access. FromPrivateKey Mode : When a private key file is provided, the cmdlet generates the corresponding public key and creates a certificate using Microsoft Entra credentials. This is helpful when you have existing private keys and want to create certificates for them. LocalUser Mode : When a local user is specified, the cmdlet generates a certificate suitable for local user authentication on storage accounts. This can be combined with existing private keys or generate new ones, matching the SSH module's local user certificate capabilities.</maml:para>

      <maml:para>The generated certificates are typically valid for 1 hour and can be used with any SFTP client that supports SSH certificate authentication. The certificates are signed by Microsoft Entra's trusted CA and will be accepted by Azure Storage accounts where your Microsoft Entra identity has appropriate permissions.</maml:para>

      <maml:para>You must be signed in to Azure with an account that has appropriate RBAC permissions (such as Storage Blob Data Contributor or Storage Blob Data Owner) on the target storage accounts.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-AzSftpCertificate</maml:name>

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

          <maml:name>CertificatePath</maml:name>

          <maml:description>

            <maml:para>Path to write SSH certificate to.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="none">

          <maml:name>LocalUser</maml:name>

          <maml:description>

            <maml:para>Username for a local user in the target storage account.</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="i">

          <maml:name>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen).</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>

          <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>New-AzSftpCertificate</maml:name>

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

          <maml:name>CertificatePath</maml:name>

          <maml:description>

            <maml:para>Path to write SSH certificate to.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="i">

          <maml:name>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen).</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>

          <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>New-AzSftpCertificate</maml:name>

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

          <maml:name>CertificatePath</maml:name>

          <maml:description>

            <maml:para>Path to write SSH certificate to.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="i">

          <maml:name>PrivateKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to private key file.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen).</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>

          <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>New-AzSftpCertificate</maml:name>

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

          <maml:name>CertificatePath</maml:name>

          <maml:description>

            <maml:para>Path to write SSH certificate to.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

          <dev:type>

            <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="p">

          <maml:name>PublicKeyFile</maml:name>

          <maml:description>

            <maml:para>Path to public key file.</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>SshClientFolder</maml:name>

          <maml:description>

            <maml:para>Directory containing SSH executables (ssh-keygen).</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>

          <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="OutputFile, o">

        <maml:name>CertificatePath</maml:name>

        <maml:description>

          <maml:para>Path to write SSH certificate to.</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="AzContext, 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.Core.IAzureContextContainer</command:parameterValue>

        <dev:type>

          <maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.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>Forces the command to run without asking for user confirmation to overwrite existing SSH key pairs.</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="False" position="named" aliases="none">

        <maml:name>LocalUser</maml:name>

        <maml:description>

          <maml:para>Username for a local user in the target storage account.</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="i">

        <maml:name>PrivateKeyFile</maml:name>

        <maml:description>

          <maml:para>Path to private key file.</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="named" aliases="p">

        <maml:name>PublicKeyFile</maml:name>

        <maml:description>

          <maml:para>Path to public key file.</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>SshClientFolder</maml:name>

        <maml:description>

          <maml:para>Directory containing SSH executables (ssh-keygen).</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>None</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.Sftp.Models.PSCertificateInfo</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: Generate certificate with automatic key generation </maml:title>

        <dev:code>New-AzSftpCertificate</dev:code>

        <dev:remarks>

          <maml:para>This command generates a new SSH key pair and creates a certificate signed by Microsoft Entra. The key pair and certificate are saved in the system temp directory with auto-generated filenames. This is the simplest way to get started with SFTP authentication.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>------- Example 2: Generate certificate with custom path -------</maml:title>

        <dev:code>New-AzSftpCertificate -CertificatePath "C:\certs\azure-sftp.cert"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a new SSH key pair and creates a certificate, saving the certificate to the specified path. The private and public keys will be saved in the same directory with corresponding names (azure-sftp and azure-sftp.pub).</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-- Example 3: Generate certificate from existing private key --</maml:title>

        <dev:code>New-AzSftpCertificate -PrivateKeyFile "C:\keys\id_rsa" -CertificatePath "C:\certs\id_rsa.cert"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate from an existing SSH private key. The cmdlet will automatically derive the public key from the private key and create a certificate signed by Microsoft Entra. This is useful when you have existing private keys and want to create certificates for them.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>--- Example 4: Generate certificate from existing public key ---</maml:title>

        <dev:code>New-AzSftpCertificate -PublicKeyFile "C:\keys\id_rsa.pub" -CertificatePath "C:\certs\id_rsa.cert"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate from an existing SSH public key. This is useful when you want to create certificates for existing public keys that are already configured on storage accounts.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title> Example 5: Generate certificate for local user authentication </maml:title>

        <dev:code>New-AzSftpCertificate -LocalUser "sftpuser" -CertificatePath "C:\certs\localuser.cert"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate suitable for local user authentication on storage accounts. A new key pair is generated and the certificate is configured for the specified local user. This aligns with the SSH module's local user authentication capabilities.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 6: Generate certificate for local user with existing private key</maml:title>

        <dev:code>New-AzSftpCertificate -LocalUser "sftpuser" -PrivateKeyFile "C:\keys\existing_key" -CertificatePath "C:\certs\localuser.cert"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate for local user authentication using an existing private key. This is useful when you want to use specific keys for local user authentication on storage accounts.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>----- Example 7: Generate certificate with automatic paths -----</maml:title>

        <dev:code>$cert = New-AzSftpCertificate

Write-Host "Certificate: $($cert.CertificatePath)"

Write-Host "Private Key: $($cert.PrivateKeyPath)"

Write-Host "Valid Until: $($cert.ValidUntil)"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate with automatic key generation and temporary file paths. The returned object contains all the file paths and certificate information, making it easy to use programmatically.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>- Example 8: Generate certificate and use with Connect-AzSftp -</maml:title>

        <dev:code># Generate certificate for local user

$cert = New-AzSftpCertificate -LocalUser "sftpuser" -CertificatePath "C:\certs\sftp-auth.cert"

# Use the certificate to connect to storage account

$process = Connect-AzSftp -StorageAccount "mystorageaccount" -LocalUser "sftpuser" -PrivateKeyFile $cert.PrivateKeyPath

# Display connection info

Write-Host "SFTP connection established using certificate: $($cert.CertificatePath)"

Write-Host "Process ID: $($process.Id)"</dev:code>

        <dev:remarks>

          <maml:para>This example demonstrates the full workflow of generating a certificate and immediately using it for SFTP connection, showing the integration between the two cmdlets.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>Example 9: Generate certificate with custom SSH client location</maml:title>

        <dev:code>New-AzSftpCertificate -CertificatePath "C:\certs\custom-cert.pub" -SshClientFolder "C:\Program Files\OpenSSH"</dev:code>

        <dev:remarks>

          <maml:para>This command generates a certificate using SSH executables from a specific location. This is useful when you have multiple SSH implementations installed or when ssh-keygen is not in the default PATH.</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://learn.microsoft.com/powershell/module/az.sftp/new-azsftpcertificate</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Connect-AzSftp</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Azure Storage SFTP Support</maml:linkText>

        <maml:uri>https://docs.microsoft.com/en-us/azure/storage/blobs/secure-file-transfer-protocol-support</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>OpenSSH Certificate Authentication</maml:linkText>

        <maml:uri>https://www.openssh.com/txt/release-5.4</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>