Get-AzStorageFileContent

ファイルの内容をダウンロードします。

構文

Get-AzStorageFileContent
   [-ShareName] <String>
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-DisAllowTrailingDot]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-Share] <CloudFileShare>
   [-ShareClient <ShareClient>]
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-Directory] <CloudFileDirectory>
   [-ShareDirectoryClient <ShareDirectoryClient>]
   [-Path] <String>
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]
Get-AzStorageFileContent
   [-File] <CloudFile>
   [-ShareFileClient <ShareFileClient>]
   [[-Destination] <String>]
   [-CheckMd5]
   [-PassThru]
   [-Force]
   [-AsJob]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [-WhatIf]
   [-Confirm]
   [-PreserveSMBAttribute]
   [<CommonParameters>]

説明

Get-AzStorageFileContent コマンドレットは、ファイルの内容をダウンロードし、指定した宛先に保存します。 このコマンドレットは、ファイルの内容を返しません。

例 1: フォルダーからファイルをダウンロードする

Get-AzStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWorkingFolder/CurrentDataFile"

このコマンドは、ContosoWorkingFolder フォルダー内の CurrentDataFile という名前のファイルを、ファイル共有 ContosoShare06 から現在のフォルダーにダウンロードします。

例 2: サンプル ファイル共有のファイルをダウンロードする

Get-AzStorageFile -ShareName sample | Where-Object {$_.GetType().Name -eq "CloudFile"} | Get-AzStorageFileContent

この例では、サンプル ファイル共有の下にファイルをダウンロードします

例 3: ローカル ファイルに Azure ファイルをダウンロードし、ローカル ファイルの Azure File S MB (メガバイト) プロパティ (ファイル属性、ファイル作成時刻、ファイル最終書き込み時刻) を指定します。

Get-AzStorageFileContent -ShareName sample -Path "dir1/file1" -Destination $localFilePath -PreserveSMBAttribute

この例では、ローカル ファイルに Azure ファイルをダウンロードし、ローカル ファイルの Azure File S MB (メガバイト) プロパティ (ファイル属性、ファイル作成時刻、ファイルの最終書き込み時刻) を指定します。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckMd5

ダウンロードしたファイルの Md5 合計をチェックするかどうかを指定します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClientTimeoutPerRequest

1 つのサービス要求に対するクライアント側のタイムアウト間隔を秒単位で指定します。 指定した間隔で前の呼び出しが失敗した場合、このコマンドレットは要求を再試行します。 間隔が経過する前にこのコマンドレットが正常な応答を受け取らない場合、このコマンドレットはエラーを返します。

Type:Nullable<T>[Int32]
Aliases:ClientTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConcurrentTaskCount

同時ネットワーク呼び出しの最大数を指定します。 このパラメーターを使用すると、同時ネットワーク呼び出しの最大数を指定することで、ローカル CPU と帯域幅の使用量を調整するコンカレンシーを制限できます。 指定した値は絶対カウントであり、コア数には乗算されません。 このパラメーターは、1 秒あたり 100 キロビットなどの低帯域幅環境でのネットワーク接続の問題を減らすのに役立ちます。 既定値は 10 です。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Azure Storage コンテキストを指定します。 コンテキストを取得するには、New-AzStorageContext コマンドレットを使用します。

Type:IStorageContext
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Destination

宛先パスを指定します。 このコマンドレットは、このパラメーターが指定した場所にファイルの内容をダウンロードします。 存在しないファイルのパスを指定した場合、このコマンドレットはそのファイルを作成し、その内容を新しいファイルに保存します。 既に存在するファイルのパスを指定し、Force パラメーターを指定すると、コマンドレットによってファイルが上書きされます。 既存のファイルのパスを指定し、Force を指定しない場合は、続行する前にプロンプトが表示されます。 フォルダーのパスを指定すると、このコマンドレットは Azure ストレージ ファイルの名前を持つファイルの作成を試みます。

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Directory

フォルダーを CloudFileDirectory オブジェクトとして指定します。 このコマンドレットは、このパラメーターが指定するフォルダー内のファイルのコンテンツを取得します。 ディレクトリを取得するには、New-AzStorageDirectory コマンドレットを使用します。 Get-AzStorageFile コマンドレットを使用してディレクトリを取得することもできます。

Type:CloudFileDirectory
Aliases:CloudFileDirectory
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DisAllowTrailingDot

末尾のドット (.) をディレクトリ名とファイル名にサフィックス付けしないようにします。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-File

ファイルを CloudFile オブジェクトとして指定します。 このコマンドレットは、このパラメーターが指定するファイルを取得します。 CloudFile オブジェクトを取得するには、Get-AzStorageFile コマンドレットを使用します。

Type:CloudFile
Aliases:CloudFile
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

存在しないファイルのパスを指定した場合、このコマンドレットはそのファイルを作成し、その内容を新しいファイルに保存します。 既に存在するファイルのパスを指定し、Force パラメーターを指定すると、コマンドレットによってファイルが上書きされます。 既存のファイルのパスを指定し、Force を指定しない場合は、続行する前にプロンプトが表示されます。 フォルダーのパスを指定すると、このコマンドレットは Azure ストレージ ファイルの名前を持つファイルの作成を試みます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

このコマンドレットは、ダウンロードした AzureStorageFile オブジェクトを返します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

ファイルのパスを指定します。 このコマンドレットは、このパラメーターが指定するファイルの内容を取得します。 ファイルが存在しない場合、このコマンドレットはエラーを返します。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PreserveSMBAttribute

コピー元ファイルの S MB (メガバイト) プロパティ (ファイル属性、ファイル作成時刻、ファイルの最終書き込み時刻) をコピー先ファイルに保持します。 このパラメーターは Windows でのみ使用できます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerTimeoutPerRequest

要求のサービス側のタイムアウト間隔を秒単位で指定します。 サービスが要求を処理する前に指定した間隔が経過すると、ストレージ サービスはエラーを返します。

Type:Nullable<T>[Int32]
Aliases:ServerTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Share

CloudFileShare オブジェクトを指定します。 このコマンドレットは、このパラメーターが指定する共有内のファイルの内容をダウンロードします。 CloudFileShare オブジェクトを取得するには、Get-AzStorageShare コマンドレットを使用します。 このオブジェクトには、ストレージ コンテキストが含まれています。 このパラメーターを指定する場合は、Context パラメーターを指定しないでください。

Type:CloudFileShare
Aliases:CloudFileShare
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ShareClient

CloudFileShare オブジェクトは、ファイルをダウンロードする共有を示しました。

Type:ShareClient
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ShareDirectoryClient

ShareDirectoryClient オブジェクトは、ファイルがダウンロードされるクラウド ディレクトリを示しました。

Type:ShareDirectoryClient
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ShareFileClient

ShareFileClient オブジェクトは、ダウンロードするクラウド ファイルを示しました。

Type:ShareFileClient
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ShareName

ファイル共有の名前を指定します。 このコマンドレットは、このパラメーターが指定する共有内のファイルの内容をダウンロードします。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

CloudFileShare

CloudFileDirectory

CloudFile

IStorageContext

出力

AzureStorageFile