Set-AzResourceGroup

  • 參考
模組:
Az.Resources

修改資源群組。

Syntax

Set-AzResourceGroup
   -Name <String>
   [-Tag] <Hashtable>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzResourceGroup
   [-Tag] <Hashtable>
   -Id <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Set-AzResourceGroup Cmdlet 會修改資源群組的屬性。 您可以使用此 Cmdlet 來新增、變更或刪除套用至資源群組的 Azure 標籤。 指定 Name 參數，以識別要修改標籤的資源群組和 Tag 參數。 您無法使用此 Cmdlet 來變更資源群組的名稱。

範例

範例 1：將標籤套用至資源群組

Set-AzResourceGroup -Name "ContosoRG" -Tag @{Department="IT"}

此命令會將具有 IT 值的 Department 標籤套用至沒有現有標籤的資源群組。

範例 2：將標籤新增至資源群組

$Tags = (Get-AzResourceGroup -Name "ContosoRG").Tags
$Tags
$Tags += @{"Status"="Approved"; "FY2016"=$null}
Set-AzResourceGroup -Name "ContosoRG" -Tag $Tags
(Get-AzResourceGroup -Name "ContosoRG").Tags

此範例會將 Status 標籤的值新增為 Approved 和 FY2016 標籤至具有現有標籤的資源群組。 因為您指定的標記會取代現有的標記，因此您必須在新的標籤集合中包含現有的標籤，否則將會遺失這些標記。 第一個命令會取得 ContosoRG 資源群組，並使用 dot 方法來取得其 Tags 屬性的值。 命令會將標記儲存在 $Tags 變數中。 第二個命令會取得$Tags變數中的標記。 第三個命令會使用 += 指派運算符，將 Status 和 FY2016 標記新增至$Tags變數中的標記數位。 第四個命令會使用 Set-AzResourceGroup 的 Tag 參數，將$Tags 變數中的標籤套用至 ContosoRG 資源群組。 第五個命令會取得套用至 ContosoRG 資源群組的所有標記。 輸出顯示資源群組具有 Department 標籤和兩個新標籤 Status 和 FY2015。

範例 3：刪除資源群組的所有標籤

Set-AzResourceGroup -Name "ContosoRG" -Tag @{}

此命令會 指定具有空白哈希表值的 Tag 參數，以從 ContosoRG 資源群組中刪除所有標籤。

參數

-ApiVersion

指定資源提供者支援的 API 版本。 您可以指定與預設版本不同的版本。

Type:String
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

-Id

指定要修改的資源群組識別碼。

Type:String
Aliases:ResourceGroupId, ResourceId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

指定要修改的資源群組名稱。

Type:String
Aliases:ResourceGroupName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Pre

指出此 Cmdlet 會在自動判斷要使用的版本時，考慮發行前版本 API 版本。

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

-Tag

哈希表形式的索引鍵/值組。 例如：@{key0=“value0”;key1=$null;key2=“value2”} 標記是一個名稱/值組，您可以建立並套用至資源和資源群組。 將標籤名稱給資源和群組之後，您可以使用 Get-AzResource 和 Get-AzResourceGroup 的 Tag 參數，依標記名稱或名稱和值搜尋資源和群組。 您可以使用標籤來分類您的資源，例如依部門或成本中心，或追蹤有關資源的附註或批註。 若要新增或變更標記，您必須取代資源群組的標籤。 若要刪除標籤，請從 Get-AzResourceGroup 輸入哈希表，其中包含目前套用至資源群組的所有標籤，但您想要刪除的標籤除外。 若要刪除資源群組中的所有標籤，請指定空的哈希表： @{}。

Type:Hashtable
Aliases:Tags
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

輸入

String

Hashtable

輸出

PSResourceGroup