Policy Assignments - Get By Id

參考

服務:: Policy

API 版本:: 2023-04-01

作業會擷取具有指定標識符的原則指派。原則指派標識符的格式如下：『{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}』。有效範圍包括：管理群組（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'），訂用帳戶（格式：'/subscriptions/{subscriptionId}'），資源群組（格式： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'，或資源（格式： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'。

GET https://management.azure.com/{policyAssignmentId}?api-version=2023-04-01

含選擇性參數:

GET https://management.azure.com/{policyAssignmentId}?$expand={$expand}&api-version=2023-04-01

URI 參數

名稱	位於	必要	類型	Description
policyAssignmentId	path	True	string	要取得的原則指派標識碼。使用格式 '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'。
api-version	query	True	string	要用於這項作業的 API 版本。
$expand	query		string	要包含在回應中的其他屬性逗號分隔清單。支援的值為 'LatestDefinitionVersion， EffectiveDefinitionVersion'。

回應

名稱	類型	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	模擬您的用戶帳戶

範例

Retrieve a policy assignment by ID

Retrieve a policy assignment with a managed identity by ID

Retrieve a policy assignment by ID

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01

範例回覆

狀態碼:: 200

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Retrieve a policy assignment with a managed identity by ID

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01

範例回覆

狀態碼:: 200

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

定義

名稱	Description
CloudError	原則作業的錯誤回應。
createdByType	建立資源的身分識別類型。
enforcementMode	原則指派強制模式。可能的值為 Default 和 DoNotEnforce。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
Identity	資源的身分識別。原則指派最多支援一個身分識別。這是系統指派的身分識別或單一使用者指派的身分識別。
NonComplianceMessage	描述資源不符合原則之原因的訊息。這會顯示在「拒絕」錯誤訊息和資源不符合規範的合規性結果中。
Override	原則屬性值覆寫。
OverrideKind	覆寫種類。
ParameterValuesValue	參數的值。
PolicyAssignment	原則指派。
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	參數的值。