New-AzureRmTag
建立預先定義的 Azure 標籤,或將值新增至現有的標籤。
警告
自 2024 年 2 月 29 日起,AzureRM PowerShell 模組已正式淘汰。 建議使用者從 AzureRM 遷移至 Az PowerShell 模組,以確保持續支援和更新。
雖然 AzureRM 模組可能仍可運作,但不再維護或支援它,但會根據用戶的判斷權和風險放置任何繼續使用。 如需轉換至 Az 模組的指引,請參閱我們的 移轉資源 。
Syntax
New-AzureRmTag
[-Name] <String>
[[-Value] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
New-AzureRmTag Cmdlet 會建立具有選擇性預先定義值的預先定義 Azure 標籤。 您也可以使用它,將其他值新增至現有的預先定義標籤。 若要建立預先定義的標籤,請輸入唯一的標籤名稱。 若要將值新增至現有的預先定義標籤,請指定現有標籤的名稱和新值。 這個 Cmdlet 會傳回 物件,此物件代表新的或已修改標記及其值,以及已套用它的資源數目。 New-AzureRmTag 所屬的 Azure 標記模組可協助您管理預先定義的 Azure 標籤。 Azure 標籤是一組名稱/值組,可用來分類 Azure 資源和資源群組,例如依部門或成本中心,或追蹤有關資源和群組的附註或批註。 您可以在單一步驟中定義和套用標籤,但預先定義的標籤可讓您為訂用帳戶中的標記建立標準、一致、可預測的名稱和值。 若要將預先定義的標籤套用至資源或資源群組,請使用 New-AzureRmTag Cmdlet 的 Tag 參數。 若要搜尋具有指定標籤名稱或名稱和值的資源群組,請使用 Get-AzureRMResourceGroup Cmdlet 的 Tag 參數。 每個標記都有名稱。 這些值是選擇性的。 預先定義的 Azure 標籤可以有多個值,但是當您將標籤套用至資源或資源群組時,您只會套用標籤名稱和其中一個值。 例如,您可以為每個部門建立預先定義的 Department 標籤,例如財務、人力資源和 IT。 當您將 Department 標籤套用至資源時,只會套用一個預先定義的值,例如 Finance。
範例
範例 1:建立預先定義的標記
PS C:\>New-AzureRmTag -Name "FY2015"
Name: FY2015
Count: 0
Values:
Name Count
========= =====
Finance 0
此命令會建立名為 FY2015 的預先定義標籤。 此標籤沒有值。 您可以將沒有值的標記套用至資源或資源群組,或使用 New-AzureRmTag 將值新增至標籤。 當您將標籤套用至資源或資源群組時,您也可以指定值。
範例 2:使用值建立預先定義的標記
PS C:\>New-AzureRmTag -Name "Department" -Value "Finance"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0
此命令會建立名為 Department 的預先定義標籤,其值為 Finance。
範例 3:將值新增至預先定義的標籤
PS C:\>New-AzureRmTag -Name "Department" -Value "Finance"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0
PS C:\>New-AzureRmTag -Name "Department" -Value "IT"
Name: Department
Count: 0
Values:
Name Count
========= =====
Finance 0
IT 0
這些命令會以兩個值建立名為 Department 的預先定義標籤。 如果標記名稱存在, New-AzureRmTag 會將值新增至現有的標籤,而不是建立新的標籤。
範例 4:使用預先定義的標記
PS C:\>New-AzureRmTag -Name "CostCenter" -Value "0001"
Name: CostCenter
Count: 0
Values:
Name Count
========= =====
0001 0
PS C:\>Set-AzureRmResourceGroup -Name "EngineerBlog" -Tag @{Name="CostCenter";Value="0001"}
Name: EngineerBlog
Location: East US
Resources:
Name Type Location
=============== ======================= ========
EngineerBlog Microsoft.Web/sites West US
EngSvr01 Microsoft.Sql/servers West US
EngDB02 Microsoft.Sql/databases West US
Tags:
Name Value
========== =====
CostCenter 0001
PS C:\>Get-AzureRmTag -Name "CostCenter"
Name: CostCenter
Count: 1
Values:
Name Count
========= =====
0001 1
PS C:\>Get-AzureRmResourceGroup -Tag @{Name="CostCenter"}
Name: EngineerBlog
Location: East US
Resources:
Name Type Location
=============== ======================= ========
EngineerBlog Microsoft.Web/sites West US
EngSvr01 Microsoft.Sql/servers West US
EngDB02 Microsoft.Sql/databases West US
Tags:
Name Value
========== =====
CostCenter 0001
此範例中的命令會建立並使用預先定義的標記。
參數
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
指定標記名稱。 若要建立新的預先定義標籤,請輸入唯一的名稱。 若要將值新增至現有的標籤,請輸入現有標籤的名稱。 如果現有的預先定義標籤具有指定的名稱, New-AzureRmTag 會將指定的值新增至具有該名稱的標記,而不是建立新的標記。
Type: | String |
Position: | 0 |
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 |