New-AzPolicyEnrollment
語法
Default (預設值)
New-AzPolicyEnrollment
-Name <String>
-Scope <String>
[-AssignmentScopeValidation <String>]
[-Description <String>]
[-DisplayName <String>]
[-Metadata <String>]
[-PolicyAssignmentId <String>]
[-PolicyDefinitionReferenceId <String[]>]
[-ResourceSelector <IResourceSelector[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
這個 New-AzPolicyEnrollment 指令檔會建立一個具有指定範圍與名稱的政策註冊。
政策註冊適用於其範圍內的所有資源。
例如,當你在資源群組範圍內建立政策註冊,針對相同或更高層級的政策指派時,該登錄會適用於該資源群組中所有適用的資源。
範例
範例一:訂閱範圍下的保單登記
$Subscription = Get-AzSubscription -SubscriptionName 'Subscription01'
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -PolicyAssignmentId $Assignment.Id -Scope "/subscriptions/$($Subscription.Id)" -DisplayName 'VM Policy Enrollment'
第一個命令會使用 Get-AzSubscription Cmdlet 取得名為 Subscription01 的訂用帳戶,並將它儲存在 $Subscription 變數中。
第二個命令會使用 Get-AzPolicyAssignment Cmdlet 取得名為 VirtualMachinePolicyAssignment 的原則指派,並將它儲存在 $Assignment 變數中。
該指派必須將 EnforcementMode 設定為 Enroll。
最後一個指令會在訂閱範圍字串所識別的訂閱層級建立$Assignment指派的政策註冊。
範例 2:管理組範圍內的政策登錄
$ManagementGroup = Get-AzManagementGroup -GroupName 'AManagementGroup'
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -PolicyAssignmentId $Assignment.Id -Scope $ManagementGroup.Id -Description 'Enrollment for VM policy at MG level'
第一個命令會使用 Get-AzManagementGroup Cmdlet 取得名為 AManagementGroup 的管理群組,並將它儲存在 $ManagementGroup 變數中。
第二個命令會使用 Get-AzPolicyAssignment Cmdlet 取得名為 VirtualMachinePolicyAssignment 的原則指派,並將它儲存在 $Assignment 變數中。
該指派必須將 EnforcementMode 設定為 Enroll。
最後一個指令會在 $ManagementGroup 的 Id 屬性所識別的管理群組範圍內,建立該指派的政策註冊$Assignment。
範例 3:使用資源選擇器進行政策註冊
$subscription = (Get-AzContext).Subscription
$Assignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment'
$ResourceSelector = @{Name = "MyLocationSelector"; Selector = @(@{Kind = "resourceLocation"; In = @("eastus", "eastus2")})}
New-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -Scope "/subscriptions/$($subscription.Id)" -PolicyAssignmentId $Assignment.Id -ResourceSelector $ResourceSelector
第一個指令會取得註冊建立的訂閱,也就是目前使用的訂閱。
第二個命令會使用 Get-AzPolicyAssignment Cmdlet 取得名為 VirtualMachinePolicyAssignment 的原則指派,並將它儲存在 $Assignment 變數中。
第三個指令建立一個資源選擇物件,將登錄限制在位於美國東部或美國東部 2 的資源,並將資料儲存在 $ResourceSelector 變數中。
最後一個指令會根據$ResourceSelector指定的資源選擇器,建立指派的政策註冊$Assignment。
參數
-AssignmentScopeValidation
是否驗證註冊的選項是在指派範圍內或在指派範圍內。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | 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 |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DisplayName
保單登記的顯示名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
保單登記的元資料。
元數據是開放式物件,通常是索引鍵值組的集合。
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
保單登記名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | PolicyEnrollmentName |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PolicyAssignmentId
正在登記的保單分配的 ID。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PolicyDefinitionReferenceId
當相關的政策指派是針對政策集(initiative)時,可以用來指定政策定義參考 ID,用於應註冊的政策集中政策定義。
這些 ID 對應於政策集定義中的子集 policyDefinitions[*].policyDefinitionReferenceId 。
當指定且非空時,僅會註冊到參考的政策定義。
否則,整個保單集都會被註冊。
參數屬性
| 類型: | String[]
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResourceSelector
依資源屬性篩選原則的資源選取器清單。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | 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 |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸出