Remove-AzRmStorageShare

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

ストレージ ファイル共有を削除します。

構文

Remove-AzRmStorageShare
      [-ResourceGroupName] <String>
      [-StorageAccountName] <String>
      -Name <String>
      [-Force]
      [-Include <String>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzRmStorageShare
      [-ResourceGroupName] <String>
      [-StorageAccountName] <String>
      -Name <String>
      -SnapshotTime <DateTime>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzRmStorageShare
      -Name <String>
      -StorageAccount <PSStorageAccount>
      [-Force]
      [-Include <String>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzRmStorageShare
      -Name <String>
      -StorageAccount <PSStorageAccount>
      -SnapshotTime <DateTime>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzRmStorageShare
      [-ResourceId] <String>
      [-Force]
      [-Include <String>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzRmStorageShare
      -InputObject <PSShare>
      [-Force]
      [-Include <String>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

New-AzRmStorageShare コマンドレットは、ストレージ ファイル共有を削除します。

例

例 1: ストレージ アカウント名と共有名を使用してストレージ ファイル共有を削除する

Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare"

このコマンドは、ストレージ アカウント名と共有名を持つストレージ ファイル共有を削除します。

例 2: ストレージ アカウント オブジェクトと共有名を使用してストレージ ファイル共有を削除する

$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount"
Remove-AzRmStorageShare -StorageAccount $accountObject -Name "myshare"

このコマンドは、ストレージ アカウント オブジェクトと共有名を持つストレージ ファイル共有を削除します。

例 3: パイプラインを使用してストレージ アカウント内のすべてのストレージ ファイル共有を削除する

Get-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" | Remove-AzRmStorageShare -Force

このコマンドは、パイプラインを使用してストレージ アカウント内のすべてのストレージ ファイル共有を削除します。

例 4: 単一のストレージ ファイル共有スナップショットを削除する

Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -SnapshotTime "2021-05-10T08:04:08Z"

このコマンドは、特定の共有名とスナップショット時間を持つ 1 つのストレージ ファイル共有スナップショットを削除します

例 5: ストレージ ファイル共有を削除し、スナップショット

Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -Include Snapshots

このコマンドは、ストレージ ファイル共有を削除し、スナップショット既定では、ファイル共有に "-include" パラメーターのないスナップショットがある場合、コマンドレットは失敗します。

例 6: ストレージ ファイル共有とそのすべてのスナップショットを削除する (リースされたスナップショットを含む)

Remove-AzRmStorageShare -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount" -Name "myshare" -Include Leased-Snapshots

このコマンドを実行すると、ストレージ ファイル共有とそのスナップショットがすべて削除され、リースされたファイルとリースされていないスナップショットが含まれます。 既定では、ファイル共有に "-include" パラメーターのないスナップショットがある場合、コマンドレットは失敗します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-Force

Share(スナップショット) とその中のすべてのコンテンツを強制的に削除する

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

-Include

有効な値は、スナップショット、leased-スナップショット、none です。 既定値は none です。 'none' の場合、共有スナップショットがない場合、ファイル共有は削除されます。ファイル共有にスナップショット (リースまたは未リリース) が含まれている場合、削除は失敗します。 "スナップショット" の場合、ファイル共有は、そのファイル共有のすべてのスナップショットを含めて削除されます。 ファイル共有にリースされたスナップショットが含まれている場合、削除は失敗します。 'leased-スナップショットs' の場合、ファイル共有は削除され、そのファイル共有スナップショット (リース/未リリース) がすべて含まれます。

Type:String
Accepted values:None, Snapshots, Leased-Snapshots
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Storage Share オブジェクト

Type:PSShare
Aliases:Share
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

共有名

Type:String
Aliases:N, ShareName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

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

-ResourceGroupName

リソース グループ名。

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

-ResourceId

ファイル共有リソース ID を入力します。

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

-SnapshotTime

SnapshotTime の共有

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

-StorageAccount

ストレージ アカウント オブジェクト

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

-StorageAccountName

ストレージ アカウント名。

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

-WhatIf

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

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

入力

String

PSStorageAccount

PSShare

出力

Boolean