New-AzTag

  • 參考
模組:
Az.Resources

建立預先定義的 Azure 標籤，或將值新增至現有的標籤 |在資源或訂用帳戶上建立或更新整個標記集。

Syntax

New-AzTag
   [-Name] <String>
   [[-Value] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzTag
   [-ResourceId] <String>
   [-Tag] <Hashtable>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

CreatePredefinedTagSet： New-AzTag Cmdlet 會建立具有選擇性預先定義值的預先定義 Azure 卷標。 您也可以使用它，將其他值新增至現有的預先定義標籤。 若要建立預先定義的標籤，請輸入唯一的標籤名稱。 若要將值新增至現有的預先定義標籤，請指定現有標籤的名稱和新值。 這個 Cmdlet 會傳回 物件，此物件代表新的或已修改標記及其值，以及已套用它的資源數目。 New-AzTag 所屬的 Azure 標記模組可協助您管理預先定義的 Azure 標籤。 Azure 標籤是一組名稱/值組，可用來分類 Azure 資源和資源群組，例如依部門或成本中心，或追蹤有關資源和群組的附註或批註。 您可以在單一步驟中定義和套用標籤，但預先定義的標籤可讓您為訂用帳戶中的標記建立標準、一致、可預測的名稱和值。 若要將預先定義的標籤套用至資源或資源群組，請使用 New-AzTag Cmdlet 的 Tag 參數。 若要搜尋具有指定標籤名稱或名稱和值的資源群組，請使用 Get-AzResourceGroup Cmdlet 的 Tag 參數。 每個標記都有名稱。 這些值是選擇性的。 預先定義的 Azure 標籤可以有多個值，但是當您將標籤套用至資源或資源群組時，您只會套用標籤名稱和其中一個值。 例如，您可以為每個部門建立預先定義的 Department 標籤，例如財務、人力資源和 IT。 當您將 Department 標籤套用至資源時，只會套用一個預先定義的值，例如 Finance。

CreateByResourceIdParameterSet：具有 ResourceId 的 New-AzTag Cmdlet 會在資源或訂用帳戶上建立或更新整個標記集。 此作業允許在指定的資源或訂用帳戶上新增或取代整個標記集。 指定的實體最多可以有50個標籤。

範例

範例 1：建立預先定義的標記

New-AzTag -Name "FY2015"

Name   ValuesTable Count Values 
----   ----------- ----- ------
FY2015             0     {}

此命令會建立名為 FY2015 的預先定義標籤。 此標籤沒有值。 您可以將不含值的標籤套用至資源或資源群組，或使用 New-AzTag 將值新增至標記。 當您將標籤套用至資源或資源群組時，您也可以指定值。

範例 2：使用值建立預先定義的標記

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values: 

        Name        Count
        =========   =====
        Finance     0

此命令會建立名為 Department 的預先定義標籤，其值為 Finance。

範例 3：將值新增至預先定義的標籤

New-AzTag -Name "Department" -Value "Finance"

Name:   Department
Count:  0
Values: 
        Name        Count
        =========   =====
        Finance     0 
New-AzTag -Name "Department" -Value "IT"
Name:   Department
Count:  0
Values: 
        Name        Count
        =========   =====
        Finance     0
        IT          0

這些命令會以兩個值建立名為 Department 的預先定義標籤。 如果標記名稱存在， New-AzTag 會將值新增至現有的標籤，而不是建立新的標籤。

範例 4：使用預先定義的標記

New-AzTag -Name "CostCenter" -Value "0001"

Name:   CostCenter
Count:  0
Values: 
        Name        Count
        =========   =====
        0001        0 

Set-AzResourceGroup -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 

Get-AzTag -Name "CostCenter"

Name:   CostCenter
Count:  1
Values: 
        Name        Count
        =========   =====
        0001        1 

Get-AzResourceGroup -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

此範例中的命令會建立並使用預先定義的標記。

範例 5：在訂用帳戶上建立或更新整個標記集

$Tags = @{"tagKey1"="tagValue1"; "tagKey2"="tagValue2"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tag $Tags

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             tagKey1  tagValue1
             tagKey2  tagValue2

此命令會使用 {subId} 在訂用帳戶上建立或更新整個標記集。

範例 6：在資源上建立或更新整個標記集

$Tags = @{"Dept"="Finance"; "Status"="Normal"}
New-AzTag -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/Microsoft.Sql/servers/Server1 -Tag $Tags

Id         : {Id}
Name       : {Name}
Type       : {Type}
Properties :
             Name     Value
             =======  =========
             Dept     Finance
             Status   Normal

此命令會使用 {resourceId} 在資源上建立或更新整個標記集。

參數

-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

指定預先定義的標記名稱。 若要建立新的預先定義標籤，請輸入唯一的名稱。 若要將值新增至現有的標籤，請輸入現有標籤的名稱。 如果現有的預先定義標籤是指定的名稱， New-AzTag 會將指定的值新增至具有該名稱的標記，而不是建立新的標記。

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

-ResourceId

要標記之實體的資源標識碼。 可能會標記資源、資源群組或訂用帳戶。

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

-Tag

要放在資源的標記。

Type:Hashtable
Position:1
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

Hashtable

輸出

Microsoft.Azure.Commands.ResourceManager.Common.Tags.PSTag | Microsoft.Azure.Commands.Tags.Model.PSTagResource