Update-AzPolicyEnrollment
語法
UpdateByNameAndScope (預設值)
Update-AzPolicyEnrollment
-Name <String>
-Scope <String>
[-Description <String>]
[-DisplayName <String>]
[-AssignmentScopeValidation <String>]
[-ResourceSelector <IResourceSelector[]>]
[-PolicyDefinitionReferenceId <String[]>]
[-Metadata <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Update-AzPolicyEnrollment
-InputObject <IPolicyEnrollment>
[-Description <String>]
[-DisplayName <String>]
[-AssignmentScopeValidation <String>]
[-ResourceSelector <IResourceSelector[]>]
[-PolicyDefinitionReferenceId <String[]>]
[-Metadata <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
UpdateById
Update-AzPolicyEnrollment
-Id <String>
[-Description <String>]
[-DisplayName <String>]
[-AssignmentScopeValidation <String>]
[-ResourceSelector <IResourceSelector[]>]
[-PolicyDefinitionReferenceId <String[]>]
[-Metadata <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Update-AzPolicyEnrollment 指令碼子讓步文更新了一份包含新提供的屬性的政策註冊。
未提供的財產將保留於現有登記名單中。
範例
範例 1:更新顯示名稱
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope $ResourceGroup.ResourceId
Update-AzPolicyEnrollment -Id $PolicyEnrollment.Id -DisplayName 'Enrollment for VM location policy'
第一個命令會使用 Get-AzResourceGroup Cmdlet 取得名為 ResourceGroup11 的資源群組。
此指令會將該物件儲存在$ResourceGroup變數中。
第二個指令則是透過使用 Get-AzPolicyEnrollment cmdlet 取得名為 PolicyEnrollment07 的政策註冊。
指令會將該物件儲存在 $PolicyEnrollment 變數中。
最後一個指令會更新由 $PolicyEnrollment ID 屬性所識別的政策註冊上的顯示名稱。
範例 2:透過管線更新
$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope "/subscriptions/$((Get-AzContext).Subscription.Id)"
$PolicyEnrollment.DisplayName = 'Updated VM Enrollment'
$PolicyEnrollment | Update-AzPolicyEnrollment
第一個指令是透過 Get-AzPolicyEnrollment cmdlet 取得名為 PolicyEnrollment07 的政策註冊,並將其儲存在 $PolicyEnrollment 變數中。
第二個指令會在$PolicyEnrollment物件上設定新的顯示名稱。
最後一個指令會將修改過的物件導管到 Update-AzPolicyEnrollment,以持久化變更。
範例 3:更新資源選擇器
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$ResourceSelector = @{Name = "MyLocationSelector"; Selector = @(@{Kind = "resourceLocation"; NotIn = @("eastus", "eastus2")})}
Update-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -Scope $ResourceGroup.ResourceId -ResourceSelector $ResourceSelector
第一個命令會使用 Get-AzResourceGroup Cmdlet 取得名為 ResourceGroup11 的資源群組。
第二個指令建立一個資源選擇物件,將資源註冊限制在東美國或東美國2以外的地點,並將資源儲存在$ResourceSelector變數中。
最後一個指令更新名為 VirtualMachinePolicyEnrollment 的政策註冊,並依 $ResourceSelector 指定的資源選擇器。
參數
-AssignmentScopeValidation
是否驗證註冊的選項是在指派範圍內或在指派範圍內。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-DefaultProfile
DefaultProfile 參數無法運作。
如果針對不同的訂用帳戶執行 Cmdlet,請使用 SubscriptionId 參數。
參數屬性
| 類型: | PSObject
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | AzureRMContext, AzureCredential |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Description
保單登記的描述。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-DisplayName
保單登記的顯示名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Id
保單登記的 ID 以更新。
請使用格式為 '{scope}/providers/Microsoft.授權/policyEnrollments/{policyEnrollmentName}'。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 資源識別碼 |
參數集
UpdateById
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
政策註冊物件需更新。
UpdateByInputObject
| Position: | Named |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
保單登記的元資料。
元數據是開放式物件,通常是索引鍵值組的集合。
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Name
保單登記名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | PolicyEnrollmentName |
參數集
UpdateByNameAndScope
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-PolicyDefinitionReferenceId
當相關的政策指派是針對政策集(initiative)時,可以用來指定政策定義參考 ID,用於應註冊的政策集中政策定義。
這些 ID 對應於政策集定義中的子集 policyDefinitions[*].policyDefinitionReferenceId 。
當指定且非空時,僅會註冊到參考的政策定義。
否則,整個保單集都會被註冊。
參數屬性
| 類型: | String[]
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ResourceSelector
依資源屬性篩選原則的資源選取器清單。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Scope
保單登記範圍。
有效的範圍包括:管理群組(格式:'/providers/Microsoft.Management/managementGroups/{managementGroup}')、訂閱(格式:'/subscriptions/{subscriptionId}')、資源群組(格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'),或資源(格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}')
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
UpdateByNameAndScope
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸出