New-AzPolicyDefinition

參考

模組:: Az.Resources

建立原則定義。

Syntax

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   -ManagementGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzPolicyDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   -Policy <String>
   [-Metadata <String>]
   [-Parameter <String>]
   [-Mode <String>]
   -SubscriptionId <Guid>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

New-AzPolicyDefinition Cmdlet 會建立原則定義，其中包含 JavaScript 物件表示法（JSON）格式的原則規則。

範例

範例 1：使用原則檔案建立原則定義

<#{
   "if": {
      "field": "location",
      "notIn": ["eastus", "westus", "centralus"]
   },
   "then": {
      "effect": "audit"
   }
}#>
New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json

此命令會建立名為 LocationDefinition 的原則定義，其中包含 C：\LocationPolicy.json中指定的原則規則。上述提供LocationPolicy.json檔案的範例內容。支援三種檔案內容格式：

僅限原則規則（上述範例）。
原則屬性物件。編輯原則定義時，此格式會顯示在入口網站中，而且可能包含參數。
完整原則物件。此格式是由 Azure 原則匯出函式所產生，而且可能包含參數。

注意：命令行上提供的值（例如參數、元數據）會覆寫檔案中存在的對應值。

範例 2：使用內嵌參數建立參數化原則定義

<#{
   "if": {
      "field": "location",
      "notIn": "[parameters('listOfAllowedLocations')]"
   },
   "then": {
      "effect": "audit"
   }
}#>
New-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Parameter '{ "listOfAllowedLocations": { "type": "array" } }'

此命令會建立名為 LocationDefinition 的原則定義，其中包含 C：\LocationPolicy.json中指定的原則規則。原則規則的參數定義會內嵌提供。

範例 3：在管理群組中內嵌建立原則定義

New-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName Dept42 -DisplayName 'Virtual Machine policy definition' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}'

此命令會在管理群組 Dept42 中建立名為 VMPolicyDefinition 的原則定義。命令會將原則指定為有效的 JSON 格式字串。

範例 4：使用元數據內嵌建立原則定義

New-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}' -Policy '{"if":{"field":"type","equals":"Microsoft.Compute/virtualMachines"},"then":{"effect":"deny"}}'

Name               : VMPolicyDefinition
ResourceId         : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition
ResourceName       : VMPolicyDefinition
ResourceType       : Microsoft.Authorization/policyDefinitions
SubscriptionId     : 11111111-1111-1111-1111-111111111111
Properties         : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=}
PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition

此命令會建立名為 VMPolicyDefinition 的原則定義，其中元數據指出其類別為「虛擬機」。命令會將原則指定為有效的 JSON 格式字串。

範例 5：使用模式內嵌建立原則定義

New-AzPolicyDefinition -Name 'TagsPolicyDefinition' -Policy '{"if":{"value":"[less(length(field(''tags'')), 3)]","equals":true},"then":{"effect":"deny"}}' -Mode Indexed

Name               : TagsPolicyDefinition
ResourceId         : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition
ResourceName       : TagsPolicyDefinition
ResourceType       : Microsoft.Authorization/policyDefinitions
SubscriptionId     : 11111111-1111-1111-1111-111111111111
Properties         : @{displayName=TagsPolicyDefinition; policyType=Custom; mode=Indexed; metadata=; parameters=; policyRule=}
PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/TagsPolicyDefinition

此命令會建立名為 TagsPolicyDefinition 的原則定義，其模式為 “Indexed”，指出應該只針對支援卷標和位置的資源類型評估原則。

參數

-ApiVersion

指定要使用的資源提供者 API 版本。如果您未指定版本，此 Cmdlet 會使用最新的可用版本。

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

-Description

指定原則定義的描述。

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

-DisplayName

指定原則定義的顯示名稱。

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

-ManagementGroupName

新原則定義的管理群組名稱。

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

-Metadata

原則定義的元數據。這可以是包含元數據的檔名路徑，也可以是元數據作為字串的路徑

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

-Mode

原則定義的模式

Type:	String
Position:	Named
Default value:	All
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

指定原則定義的名稱。

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

-Parameter

原則定義的參數宣告。這可以是包含參數宣告的檔名路徑，或參數宣告為字串。

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

-Policy

指定原則定義的原則規則。您可以指定.json檔案的路徑，或包含 JSON 格式原則的字串。

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

-SubscriptionId

新原則定義的訂用帳戶標識碼。

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

輸入

String

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

輸出

PSObject

New-AzPolicyDefinition

Syntax

Description

範例

範例 1：使用原則檔案建立原則定義

範例 2：使用內嵌參數建立參數化原則定義

範例 3：在管理群組中內嵌建立原則定義

範例 4：使用元數據內嵌建立原則定義

範例 5：使用模式內嵌建立原則定義

參數

-ApiVersion

-DefaultProfile

-Description

-DisplayName

-ManagementGroupName

-Metadata

-Mode

-Name

-Parameter

-Policy

-Pre

-SubscriptionId

輸入

輸出

意見反應

其他資源

New-AzPolicyDefinition

Syntax

Description

範例

範例 1：使用原則檔案建立原則定義

範例 2：使用內嵌參數建立參數化原則定義

範例 3：在管理群組中內嵌建立原則定義

範例 4：使用元數據內嵌建立原則定義

範例 5：使用模式內嵌建立原則定義

參數

-ApiVersion

-DefaultProfile

-Description

-DisplayName

-ManagementGroupName

-Metadata

-Mode

-Name

-Parameter

-Policy

-Pre

-SubscriptionId

輸入

輸出

相關連結

意見反應

其他資源