Remove-AzRmStorageShare

  • 參考
模組:
Az.Storage

拿掉 儲存體 檔案共用。

Syntax

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>]

Description

New-AzRm 儲存體 Share Cmdlet 會移除檔案共享 儲存體。

範例

範例 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” 參數的快照集，Cmdlet 將會失敗。

範例 6：移除 儲存體 檔案共用及其所有快照集（包括租用的快照集）

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

此命令會移除 儲存體 檔案共用及其所有快照集，包括已租用和未租用的快照集。 根據預設，如果檔案共享有沒有 “-include” 參數的快照集，Cmdlet 將會失敗。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

強制移除共用（快照集）及其中的所有內容

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

-Include

有效值為：快照集、租用快照集、無。 預設值為 none。 若沒有共用快照集，則會刪除檔案共用。如果檔案共用包含任何快照集（租用或未發行），則刪除會失敗。 針對「快照集」，檔案共用會遭到刪除，包括其所有檔案共用快照集。 如果檔案共用包含租用的快照集，則刪除會失敗。 若為 「leased-snapshots」，則會刪除檔案共用，並包含其所有檔案共用快照集 （leased / unleased）。

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

-InputObject

儲存體 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

指出此 Cmdlet 會傳回 Boolean ，反映作業的成功。 根據預設，此 Cmdlet 不會傳回值。

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

輸入檔案共用資源標識碼。

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

-SnapshotTime

Share 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

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

String

PSStorageAccount

PSShare

輸出

Boolean