以程式設計方式建立原則

發行項
10/01/2024

本文會逐步引導您以程式設計方式建立及管理原則。 Azure 原則定義會對您的資源強制執行不同規則和影響。強制執行可確保資源符合您的公司標準和服務等級協定。

如需合規性相關資訊，請參閱取得合規性資料。

必要條件

開始之前，請確定您已符合下列必要條件：

請安裝 ARMClient (如果尚未安裝)。此工具會將 HTTP 要求傳送至以 Azure Resource Manager 為基礎的 API。
將您的 Azure PowerShell 模組更新為最新版本。如需詳細資訊，請參閱安裝 Azure PowerShell 模組。如需最新版本的詳細資訊，請參閱 Azure PowerShell。
使用 Azure PowerShell 來註冊 Azure 原則見解資源提供者，以驗證您的訂用帳戶可與資源提供者搭配使用。若要註冊資源提供者，您必須有權執行資源提供者的註冊動作作業。這項作業包含在「參與者」和「擁有者」角色中。執行下列命令以註冊資源提供者：
```
Register-AzResourceProvider -ProviderNamespace 'Microsoft.PolicyInsights'
```
如需註冊及檢視資源提供者的詳細資訊，請參閱資源提供者和類型。
如果尚未安裝 Azure CLI，請先安裝。您可以於在 Windows 上安裝 Azure CLI 中取得最新版本。

建立及指派原則定義

要更清楚看見您資源的首要步驟，是透過您的資源建立及指派原則。下一步是了解如何以程式設計方式建立及指派原則。範例原則會使用 PowerShell、Azure CLI 和 HTTP 要求，來稽核已對所有公用網路開放的儲存體帳戶。

使用 PowerShell 建立並指派原則定義

使用下列 JSON 程式碼片段建立名稱為 AuditStorageAccounts.json 的 JSON 檔案。

{
  "if": {
    "allOf": [
      {
        "field": "type",
        "equals": "Microsoft.Storage/storageAccounts"
      },
      {
        "field": "Microsoft.Storage/storageAccounts/networkAcls.defaultAction",
        "equals": "Allow"
      }
    ]
  },
  "then": {
    "effect": "audit"
  }
}

如需撰寫原則定義的詳細資訊，請參閱 Azure 原則定義結構。

執行下列命令，以使用 AuditStorageAccounts.json 檔案建立原則定義。
```
New-AzPolicyDefinition -Name 'AuditStorageAccounts' -DisplayName 'Audit Storage Accounts Open to Public Networks' -Policy 'AuditStorageAccounts.json'
```
此命令會建立名為對公用網路開放的稽核儲存體帳戶的原則定義。如需您可使用的其他參數詳細資訊，請參閱 New-AzPolicyDefinition。

若在未指定位置參數的情況下呼叫，New-AzPolicyDefinition 會預設儲存工作階段內容中所選訂用帳戶的原則定義。若要將定義儲存至不同位置，請使用下列參數：
- SubscriptionId - 儲存到不同的訂用帳戶。需要 GUID 值。
- ManagementGroupName - 儲存至管理群組。需要字串值。
建立原則定義之後，您可以執行下列命令來建立原則指派：
```
$rg = Get-AzResourceGroup -Name 'ContosoRG'
$Policy = Get-AzPolicyDefinition -Name 'AuditStorageAccounts'
New-AzPolicyAssignment -Name 'AuditStorageAccounts' -PolicyDefinition $Policy -Scope $rg.ResourceId
```
以您想要的資源群組名稱取代 ContosoRG。

上的 Scope New-AzPolicyAssignment 參數可與管理群組、訂用帳戶、資源群組或單一資源搭配使用。參數會使用傳回屬性Get-AzResourceGroup的完整資源路徑ResourceId。每個容器的 Scope 模式如下所示。請將 {rName}、{rgName}、{subId} 和 {mgName} 分別取代為您的資源名稱、資源群組名稱、訂用帳戶 ID 及管理群組名稱。 {rType}會取代為資源的資源類型，例如Microsoft.Compute/virtualMachines虛擬機的資源類型。
- 資源 - /subscriptions/{subID}/resourceGroups/{rgName}/providers/{rType}/{rName}
- 資源群組 - /subscriptions/{subId}/resourceGroups/{rgName}
- 訂用帳戶 - /subscriptions/{subId}
- 管理群組 - /providers/Microsoft.Management/managementGroups/{mgName}

如需使用 Resource Manager PowerShell 模組來管理資源原則的詳細資訊，請參閱 Az.Resources。

使用 ARMClient 來建立及指派原則定義

請使用下列程序來建立原則定義。

複製下列 JSON 程式碼片段以建立 JSON 檔案。您會在下一個步驟中呼叫該檔案。

"properties": {
  "displayName": "Audit Storage Accounts Open to Public Networks",
  "policyType": "Custom",
  "mode": "Indexed",
  "description": "This policy ensures that storage accounts with exposure to Public Networks are audited.",
  "parameters": {},
  "policyRule": {
    "if": {
      "allOf": [
        {
          "field": "type",
          "equals": "Microsoft.Storage/storageAccounts"
        },
        {
          "field": "Microsoft.Storage/storageAccounts/networkAcls.defaultAction",
          "equals": "Allow"
        }
      ]
    },
    "then": {
      "effect": "audit"
    }
  }
}

使用下列其中一個呼叫來建立原則定義︰

# For defining a policy in a subscription
armclient PUT "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/AuditStorageAccounts?api-version=2021-09-01" @<path to policy definition JSON file>

# For defining a policy in a management group
armclient PUT "/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/AuditStorageAccounts?api-version=2021-09-01" @<path to policy definition JSON file>

將上述 {subscriptionId} 取代為您訂用帳戶的識別碼，或 {managementGroupId} 以管理群組的識別碼取代。

如需查詢結構的詳細資訊，請參閱 Azure 原則定義 - 建立或更新和原則定義 - 在管理群組建立或更新。

使用下列程序來建立原則指派，並在資源群組層級指派原則定義。

複製下列 JSON 程式碼片段以建立 JSON 原則指派檔案。以您自己的值取代 <> 符號中的範例資訊。

{
  "properties": {
    "description": "This policy assignment makes sure that storage accounts with exposure to Public Networks are audited.",
    "displayName": "Audit Storage Accounts Open to Public Networks Assignment",
    "parameters": {},
    "policyDefinitionId": "/subscriptions/<subscriptionId>/providers/Microsoft.Authorization/policyDefinitions/Audit Storage Accounts Open to Public Networks",
    "scope": "/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>"
  }
}

使用下列呼叫建立原則指派︰

armclient PUT "/subscriptions/<subscriptionID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Authorization/policyAssignments/Audit Storage Accounts Open to Public Networks?api-version=2021-09-01" @<path to Assignment JSON file>

以您自己的值取代 <> 符號中的範例資訊。

如需對 REST API 執行 HTTP 呼叫的詳細資訊，請參閱 Azure REST API 資源。

使用 Azure CLI 建立並指派原則定義

若要建立原則定義，請使用下列程序：

複製下列 JSON 程式碼片段以建立 JSON 原則指派檔案。

{
  "if": {
    "allOf": [
      {
        "field": "type",
        "equals": "Microsoft.Storage/storageAccounts"
      },
      {
        "field": "Microsoft.Storage/storageAccounts/networkAcls.defaultAction",
        "equals": "Allow"
      }
    ]
  },
  "then": {
    "effect": "audit"
  }
}

如需撰寫原則定義的詳細資訊，請參閱 Azure 原則定義結構。

執行下列命令以建立原則定義：
```
az policy definition create --name 'audit-storage-accounts-open-to-public-networks' --display-name 'Audit Storage Accounts Open to Public Networks' --description 'This policy ensures that storage accounts with exposures to public networks are audited.' --rules '<path to json file>' --mode All
```
此命令會建立名為對公用網路開放的稽核儲存體帳戶的原則定義。如需有關其他可供您使用之參數的詳細資訊，請參閱 az policy definition create。

若在未指定位置參數的情況下呼叫，az policy definition creation 會預設儲存工作階段內容中所選訂用帳戶的原則定義。若要將定義儲存至不同位置，請使用下列參數：
- subscription - 儲存到不同的訂用帳戶。需要一個 GUID 值來用於訂用帳戶 ID，或需要一個「字串」值來用於訂用帳戶名稱。
- management-group - 儲存到管理群組。需要字串值。
使用下列命令以建立原則指派。以您自己的值取代角括號 < > 符號中的範例資訊。
```
az policy assignment create --name '<name>' --scope '<scope>' --policy '<policy definition ID>'
```
上的 scope az policy assignment create 參數可與管理群組、訂用帳戶、資源群組或單一資源搭配使用。此參數使用完整資源路徑。每個容器的 scope 模式如下所示。請將 {rName}、{rgName}、{subId} 和 {mgName} 分別取代為您的資源名稱、資源群組名稱、訂用帳戶 ID 及管理群組名稱。 {rType}會取代為資源的資源類型，例如Microsoft.Compute/virtualMachines虛擬機的資源類型。
- 資源 - /subscriptions/{subID}/resourceGroups/{rgName}/providers/{rType}/{rName}
- 資源群組 - /subscriptions/{subID}/resourceGroups/{rgName}
- 訂用帳戶 - /subscriptions/{subID}
- 管理群組 - /providers/Microsoft.Management/managementGroups/{mgName}

您可以使用 PowerShell 搭配下列命令來取得 Azure 原則定義識別碼：

az policy definition show --name 'Audit Storage Accounts with Open Public Networks'

針對您所建立的原則定義，其原則定義識別碼應該類似下列範例：

"/subscription/<subscriptionId>/providers/Microsoft.Authorization/policyDefinitions/Audit Storage Accounts Open to Public Networks"

如需有關如何使用 Azure CLI 來管理資源原則的詳細資訊，請參閱 Azure CLI 資源原則。

下一步

如需本文中查詢與命令的詳細資訊，請檢閱以下文章。

共用方式為