Policy Set Definitions - List Built In

參考

服務:: Policy

API 版本:: 2023-04-01

擷取內建原則集定義。
此作業會擷取符合選擇性指定$filter的所有內建原則集定義清單。如果提供 $filter='category -eq {value}' ，則傳回的清單只會包含所有符合 {value} 類別的內建原則集定義。

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

含選擇性參數:

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01&$filter={$filter}&$expand={$expand}&$top={$top}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要用於這項作業的 API 版本。
$expand	query		string	要包含在回應中的其他屬性逗號分隔清單。支援的值為 'LatestDefinitionVersion， EffectiveDefinitionVersion'。
$filter	query		string	要套用至作業的篩選條件。 $filter的有效值為：'atExactScope（）'、'policyType -eq {value}' 或 'category eq '{value}''。如果未提供$filter，則不會執行任何篩選。如果提供 $filter=atExactScope（），則傳回的清單只會包含指定範圍內的所有原則集定義。如果提供 $filter='policyType -eq {value}' ，則傳回的列表只會包含類型符合 {value} 的所有原則集定義。可能的 policyType 值為 NotSpecified、BuiltIn、Custom 和 Static。如果提供 $filter='category -eq {value}' ，則傳回的清單只會包含類別符合 {value} 的所有原則集定義。
$top	query		integer int32	要傳回的記錄數目上限。未提供$top篩選時，它會傳回 500 筆記錄。

回應

名稱	類型	Description
200 OK	PolicySetDefinitionListResult	確定 - 傳回內建原則集定義的陣列。
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	模擬您的用戶帳戶

範例

List built-in policy set definitions

GET https://management.azure.com/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_built_in_policy_set_definitions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_definitions.list_built_in()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listBuiltInPolicySetDefinitions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "properties": {
        "displayName": "[Preview]: Enable Monitoring in Azure Security Center",
        "policyType": "BuiltIn",
        "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.",
        "metadata": {
          "category": "Security Center"
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "parameters": {},
        "policyDefinitions": [
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId1"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId2"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId3"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId4"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId5"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId6"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId7"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId8"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId9"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId10"
          }
        ]
      },
      "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    }
  ]
}

定義

名稱	Description
CloudError	原則作業的錯誤回應。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
Metadata	參數的一般元數據。
ParameterDefinitionsValue	可提供給原則的參數定義。
parameterType	參數的數據類型。
ParameterValuesValue	參數的值。
PolicyDefinitionGroup	原則定義群組。
PolicyDefinitionReference	原則定義參考。
PolicySetDefinition	原則集定義。
PolicySetDefinitionListResult	原則集定義清單。
policyType	原則集定義的類型。可能的值為 NotSpecified、BuiltIn、Custom 和 Static。
systemData	與建立和上次修改資源相關的元數據。

CloudError

原則作業的錯誤回應。

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

createdByType

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

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

Metadata

參數的一般元數據。

名稱	類型	Description
assignPermissions	boolean	設定為 true，讓 Azure 入口網站在原則指派期間，於此參數的資源標識碼或資源範圍值上建立角色指派。如果您想要在指派範圍之外指派許可權，這個屬性就很有用。
description	string	參數的描述。
displayName	string	參數的顯示名稱。
strongType	string	透過入口網站指派原則定義時使用。提供內容感知值清單，供用戶選擇。

ParameterDefinitionsValue

可提供給原則的參數定義。

名稱	類型	Description
allowedValues	object[]	參數的允許值。
defaultValue	object	如果未提供任何值，則為參數的預設值。
metadata	Metadata	參數的一般元數據。
schema	object	使用自我定義 JSON 架構，在指派期間提供參數輸入的驗證。此屬性僅支持物件類型參數，並遵循架構 2019-09 實作 Json.NET。您可以在 https://json-schema.org/ 深入瞭解如何使用架構，並在 https://www.jsonschemavalidator.net/測試草稿架構。
type	parameterType	參數的數據類型。

parameterType

參數的數據類型。

名稱	類型	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

參數的值。

名稱	類型	Description
value	object	參數的值。

PolicyDefinitionGroup

原則定義群組。

名稱	類型	Description
additionalMetadataId	string	資源的資源標識碼，其中包含群組的其他元數據。
category	string	群組的類別。
description	string	群組的描述。
displayName	string	群組的顯示名稱。
name	string	群組的名稱。

PolicyDefinitionReference

原則定義參考。

名稱	類型	Description
definitionVersion	string	要使用的原則定義版本。
effectiveDefinitionVersion	string	使用中之原則定義的有效版本。只有在透過 $expand 查詢參數要求時，才會存在此狀況。
groupNames	string[]	此原則定義參考所屬的組名。
latestDefinitionVersion	string	最新版的原則定義可用。只有在透過 $expand 查詢參數要求時，才會存在此狀況。
parameters	<string, ParameterValuesValue>	參考原則規則的參數值。索引鍵是參數名稱。
policyDefinitionId	string	原則定義或原則集定義的標識碼。
policyDefinitionReferenceId	string	此原則定義參考的唯一標識碼（在原則集定義內）。

PolicySetDefinition

原則集定義。

名稱	類型	Description
id	string	原則集定義的標識碼。
name	string	原則集定義的名稱。
properties.description	string	原則集定義描述。
properties.displayName	string	原則集定義的顯示名稱。
properties.metadata	object	原則集定義元數據。元數據是開放式物件，通常是索引鍵值組的集合。
properties.parameters	<string, ParameterDefinitionsValue>	原則集定義參數，可用於原則定義參考。
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	元數據，描述原則集定義內的原則定義參考群組。
properties.policyDefinitions	PolicyDefinitionReference[]	原則定義參考的陣列。
properties.policyType	policyType	原則集定義的類型。可能的值為 NotSpecified、BuiltIn、Custom 和 Static。
properties.version	string	原則會以 #.#.# 格式設定定義版本。
properties.versions	string[]	此原則集定義的可用版本清單。
systemData	systemData	與此資源相關的系統元數據。
type	string	資源的類型（Microsoft.Authorization/policySetDefinitions）。

PolicySetDefinitionListResult

原則集定義清單。

名稱	類型	Description
nextLink	string	要用於取得下一組結果的URL。
value	PolicySetDefinition[]	原則集定義的陣列。

policyType

原則集定義的類型。可能的值為 NotSpecified、BuiltIn、Custom 和 Static。

名稱	類型	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

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

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為