共用方式為

Policy Assignments - Update

  • 參考
服務:
Policy
API 版本:
2023-04-01

此作業會以指定的範圍和名稱更新原則指派。 原則指派會套用至其範圍內所包含的所有資源。 例如，當您在資源群組範圍指派原則時，該原則會套用至群組中的所有資源。

PATCH https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01

URI 參數

名稱 位於 必要 類型 Description
policyAssignmentName
 path True

string

原則指派的名稱。

Regex 模式: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

原則指派的範圍。 有效範圍包括：管理群組（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'），訂用帳戶（格式：'/subscriptions/{subscriptionId}'），資源群組（格式： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'， 或資源 （格式： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version
 query True

string

要用於這項作業的 API 版本。

要求本文

名稱 類型 Description
identity

Identity

與原則指派相關聯的受控識別。
location

string

原則指派的位置。 只有在使用受控識別時才需要。
properties.overrides

Override[]

原則屬性值覆寫。
properties.resourceSelectors

ResourceSelector[]

依資源屬性篩選原則的資源選取器清單。

回應

名稱 類型 Description
200 OK

PolicyAssignment

確定 - 傳回原則指派的相關信息。
Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Update a policy assignment with a system assigned identity
Update a policy assignment with a user assigned identity
Update a policy assignment with overrides
Update a policy assignment with resource selectors

Update a policy assignment with a system assigned identity

範例要求

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

{
  "location": "eastus",
  "identity": {
    "type": "SystemAssigned"
  }
}

範例回覆

狀態碼:
200 
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Update a policy assignment with a user assigned identity

範例要求

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

{
  "location": "eastus",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
    }
  }
}

範例回覆

狀態碼:
200 
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Update a policy assignment with overrides

範例要求

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

{
  "properties": {
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Update a policy assignment with resource selectors

範例要求

PATCH https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

{
  "properties": {
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

定義

名稱 Description
CloudError

原則作業的錯誤回應。
createdByType

建立資源的身分識別類型。
enforcementMode

原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorResponse

錯誤回應
Identity

資源的身分識別。 原則指派最多支援一個身分識別。 這是系統指派的身分識別或單一使用者指派的身分識別。
NonComplianceMessage

描述資源不符合原則之原因的訊息。 這會顯示在「拒絕」錯誤訊息和資源不符合規範的合規性結果中。
Override

原則屬性值覆寫。
OverrideKind

覆寫種類。
ParameterValuesValue

參數的值。
PolicyAssignment

原則指派。
PolicyAssignmentUpdate

Patch 要求的原則指派。
ResourceIdentityType

識別類型。 將系統或使用者指派的身分識別新增至資源時，這是唯一的必要字段。
ResourceSelector

依資源屬性篩選原則的資源選取器。
Selector

選取器表達式。
SelectorKind

選取器種類。
systemData

與建立和上次修改資源相關的元數據。
UserAssignedIdentities

與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

CloudError

原則作業的錯誤回應。

名稱 類型 Description
error

ErrorResponse

錯誤回應
所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

enforcementMode

原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。

名稱 類型 Description
Default

string

原則效果會在資源建立或更新期間強制執行。
DoNotEnforce

string

在資源建立或更新期間，不會強制執行原則效果。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorResponse

錯誤回應

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorResponse[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

Identity

資源的身分識別。 原則指派最多支援一個身分識別。 這是系統指派的身分識別或單一使用者指派的身分識別。

名稱 類型 Description
principalId

string

資源識別的主要標識碼。 此屬性只會針對系統指派的身分識別提供
tenantId

string

資源識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供
type

ResourceIdentityType

識別類型。 將系統或使用者指派的身分識別新增至資源時，這是唯一的必要字段。
userAssignedIdentities

UserAssignedIdentities

與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

NonComplianceMessage

描述資源不符合原則之原因的訊息。 這會顯示在「拒絕」錯誤訊息和資源不符合規範的合規性結果中。

名稱 類型 Description
message

string

描述資源不符合原則之原因的訊息。 這會顯示在「拒絕」錯誤訊息和資源不符合規範的合規性結果中。
policyDefinitionReferenceId

string

原則集合定義中訊息的目標原則定義參考標識符。 這隻適用於原則指派指派原則集定義時。 如果未提供此訊息，訊息會套用至此原則指派指派的所有原則。

Override

原則屬性值覆寫。

名稱 類型 Description
kind

OverrideKind

覆寫種類。
selectors

Selector[]

選取器表達式的清單。
value

string

要覆寫原則屬性的值。

OverrideKind

覆寫種類。

名稱 類型 Description
policyEffect

string

它會覆寫原則效果類型。

ParameterValuesValue

參數的值。

名稱 類型 Description
value

object

參數的值。

PolicyAssignment

原則指派。

名稱 類型 預設值 Description
id

string

原則指派的標識碼。
identity

Identity

與原則指派相關聯的受控識別。
location

string

原則指派的位置。 只有在使用受控識別時才需要。
name

string

原則指派的名稱。
properties.definitionVersion

string

要使用的原則定義版本。
properties.description

string

如果違反原則，此訊息將會是回應的一部分。
properties.displayName

string

原則指派的顯示名稱。
properties.effectiveDefinitionVersion

string

使用中之原則定義的有效版本。 只有在透過 $expand 查詢參數要求時，才會存在此狀況。
properties.enforcementMode

enforcementMode

Default

原則指派強制模式。 可能的值為 Default 和 DoNotEnforce。
properties.latestDefinitionVersion

string

最新版的原則定義可用。 只有在透過 $expand 查詢參數要求時，才會存在此狀況。
properties.metadata

object

原則指派元數據。 元數據是開放式物件，通常是索引鍵值組的集合。
properties.nonComplianceMessages

NonComplianceMessage[]

描述資源不符合原則之原因的訊息。
properties.notScopes

string[]

原則的排除範圍。
properties.overrides

Override[]

原則屬性值覆寫。
properties.parameters

<string,  ParameterValuesValue>

指派原則規則的參數值。 索引鍵是參數名稱。
properties.policyDefinitionId

string

要指派的原則定義或原則集定義的標識碼。
properties.resourceSelectors

ResourceSelector[]

依資源屬性篩選原則的資源選取器清單。
properties.scope

string

原則指派的範圍。
systemData

systemData

與此資源相關的系統元數據。
type

string

原則指派的類型。

PolicyAssignmentUpdate

Patch 要求的原則指派。

名稱 類型 Description
identity

Identity

與原則指派相關聯的受控識別。
location

string

原則指派的位置。 只有在使用受控識別時才需要。
properties.overrides

Override[]

原則屬性值覆寫。
properties.resourceSelectors

ResourceSelector[]

依資源屬性篩選原則的資源選取器清單。

ResourceIdentityType

識別類型。 將系統或使用者指派的身分識別新增至資源時，這是唯一的必要字段。

名稱 類型 Description
None

string

表示沒有任何身分識別與資源相關聯，或應該移除現有的身分識別。
SystemAssigned

string

表示系統指派的身分識別與資源相關聯。
UserAssigned

string

表示系統指派的身分識別與資源相關聯。

ResourceSelector

依資源屬性篩選原則的資源選取器。

名稱 類型 Description
name

string

資源選取器的名稱。
selectors

Selector[]

選取器表達式的清單。

Selector

選取器表達式。

名稱 類型 Description
in

string[]

要篩選的值清單。
kind

SelectorKind

選取器種類。
notIn

string[]

要篩選掉的值清單。

SelectorKind

選取器種類。

名稱 類型 Description
policyDefinitionReferenceId

string

依原則定義參考標識元篩選原則的選取器種類。
resourceLocation

string

依資源位置篩選原則的選取器種類。
resourceType

string

依資源類型篩選原則的選取器種類。
resourceWithoutLocation

string

依沒有位置的資源篩選原則的選取器種類。

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳（UTC）。
createdBy

string

建立資源的身分識別。
createdByType

createdByType

建立資源的身分識別類型。
lastModifiedAt

string

上次修改的資源時間戳 （UTC）
lastModifiedBy

string

上次修改資源的身分識別。
lastModifiedByType

createdByType

上次修改資源的身分識別類型。

UserAssignedIdentities

與原則相關聯的使用者身分識別。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱 類型 Description