Remove-AzStorageFile

  • リファレンス
モジュール:
Az.Storage

ファイルを削除します。

構文

Remove-AzStorageFile
      [-ShareName] <String>
      [-Path] <String>
      [-PassThru]
      [-DisAllowTrailingDot]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-Share] <CloudFileShare>
      [-ShareClient <ShareClient>]
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-Directory] <CloudFileDirectory>
      [-ShareDirectoryClient <ShareDirectoryClient>]
      [-Path] <String>
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzStorageFile
      [-File] <CloudFile>
      [-ShareFileClient <ShareFileClient>]
      [-PassThru]
      [-Context <IStorageContext>]
      [-ServerTimeoutPerRequest <Int32>]
      [-ClientTimeoutPerRequest <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-ConcurrentTaskCount <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzStorageFile コマンドレットは、ファイルを削除します。

例

例 1: ファイル共有からファイルを削除する

Remove-AzStorageFile -ShareName "ContosoShare06" -Path "ContosoFile22"

このコマンドは、ContosoFile22 という名前のファイルを ContosoShare06 という名前のファイル共有から削除します。

例 2: ファイル共有オブジェクトを使用してファイル共有からファイルを取得する

Get-AzStorageShare -Name "ContosoShare06" | Remove-AzStorageFile -Path "ContosoFile22"

このコマンドでは、 Get-AzStorageShare コマンドレットを使用して ContosoShare06 という名前のファイル共有を取得し、パイプライン 演算子を使用してそのオブジェクトを現在のコマンドレットに渡します。 現在のコマンドは、ContosoShare06 から ContosoFile22 という名前のファイルを削除します。

パラメーター

-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 ストレージ コンテキストを指定します。 ストレージ コンテキストを取得するには、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

-Directory

フォルダーを CloudFileDirectory オブジェクトとして指定します。 このコマンドレットは、このパラメーターが指定するフォルダー内のファイルを削除します。

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

-PassThru

このコマンドレットは、操作の成功を 反映するブール値 を返します。 既定では、このコマンドレットは値を返しません。

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

-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

ShareClient オブジェクトは、ファイルが削除される共有を示しました。

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