Remove-AzTag
刪除預先定義的 Azure 標籤或值 |刪除資源或訂用帳戶上的整個標記集。
Syntax
Remove-AzTag
[-Name] <String>
[[-Value] <String[]>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzTag
[-PassThru]
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
RemovePredefinedTagSet: Remove-AzTag Cmdlet 會從您的訂用帳戶中刪除預先定義的 Azure 卷標和值。 若要從預先定義的標記中刪除特定值,請使用 Value 參數。 根據預設, Remove-AzTag 會刪除指定的標記及其所有值。您無法刪除目前套用至資源或資源群組的標記或值。 使用 Remove-AzTag 之前,請使用 Set-AzResourceGroup Cmdlet 的 Tag 參數,從資源或資源群組中刪除標記或值。 Remove-AzTag 所屬的 Azure 標記模組可協助您管理預先定義的 Azure 標籤。 Azure 標籤是一組名稱/值組,可用來分類 Azure 資源和資源群組,例如依部門或成本中心,或追蹤有關資源和群組的附註或批註。 您可以在單一步驟中定義和套用標籤,但預先定義的標籤可讓您為訂用帳戶中的標記建立標準、一致、可預測的名稱和值。
RemoveByResourceIdParameterSet:具有 ResourceId 的 Remove-AzTag Cmdlet 會刪除資源或訂用帳戶上的整個標記集。
範例
範例 1:刪除預先定義的標記
Remove-AzTag -Name "Department"
此命令會刪除名為 Department 及其所有值的預先定義標籤。 如果標記已套用至任何資源或資源群組,命令就會失敗。
範例 2:從預先定義的標記中刪除值
Remove-AzTag -Name "Department" -Value "HumanResources" -PassThru
Name: Department
Count: 14
Values:
Name Count
========= =====
Finance 2
IT 12
此命令會從預先定義的 Department 標籤中刪除 HumanResources 值。 它不會刪除標記。 如果值已套用至任何資源或資源群組,命令就會失敗。
範例 3:刪除訂用帳戶上的整個標記集
Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
此命令會使用 {subId} 刪除訂用帳戶上的整個標記集。 如果未傳入 「-PassThru」,則不會傳回已刪除的物件。
範例 4:刪除資源上的整個標記集
Remove-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -PassThru
Id : {Id}
Name : {Name}
Type : {Type}
Properties :
Name Value
======= =========
Dept Finance
Status Normal
此命令會使用 {resourceId} 刪除資源上的整個標記集。 傳入 “-PassThru” 時,它會傳回已刪除的 oject。
參數
-Confirm
執行 Cmdlet 之前先提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
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 |
-Name
指定要移除之預先定義的標記名稱。 根據預設, Remove-AzTag 會移除指定的標記及其所有值。 若要刪除選取的值,但不要刪除標記,請使用 Value 參數。
Type: | String |
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: | True |
Accept wildcard characters: | False |
-ResourceId
標記實體的資源標識碼。 可能會標記資源、資源群組或訂用帳戶。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Value
從預先定義的標記中刪除指定的值,但不會刪除標記。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
String[]
輸出
Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource
相關連結
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應