次の方法で共有

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"

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

例 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

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Include

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

型:String
指定可能な値:None, Snapshots, Leased-Snapshots
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

Storage Share オブジェクト

型:PSShare
Aliases:Share
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

共有名

型:String
Aliases:N, ShareName
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PassThru

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceGroupName

リソース グループ名。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceId

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

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SnapshotTime

SnapshotTime の共有

型:Nullable<T>[DateTime]
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-StorageAccount

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

型:PSStorageAccount
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-StorageAccountName

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

型:String
Aliases:AccountName
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

PSStorageAccount

PSShare

出力

Boolean