Policy Set Definitions - List

Service:

Policy

API Version:

2023-04-01

Bir abonelik için ilke kümesi tanımlarını alır.
Bu işlem, belirli bir abonelikteki isteğe bağlı verilen $filter eşleşen tüm ilke kümesi tanımlarının listesini alır. $filter için geçerli değerler şunlardır: 'atExactScope()', 'policyType -eq {value}' veya 'category eq '{value}'. $filter sağlanmazsa, filtrelenmemiş liste, doğrudan veya verilen aboneliği içeren yönetim gruplarından uygulananlar da dahil olmak üzere abonelikle ilişkili tüm ilke kümesi tanımlarını içerir. $filter=atExactScope() sağlanırsa, döndürülen liste yalnızca verilen abonelikte bulunan tüm ilke kümesi tanımlarını içerir. $filter='policyType -eq {value}' sağlanırsa, döndürülen liste yalnızca türü {value} ile eşleşen tüm ilke kümesi tanımlarını içerir. Olası policyType değerleri NotSpecified, BuiltIn ve Custom değerleridir. $filter='category -eq {value}' sağlanırsa, döndürülen liste yalnızca kategorisi {value} ile eşleşen tüm ilke kümesi tanımlarını içerir.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string uuid	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
$filter	query		string	İşlemde uygulanacak filtre. $filter için geçerli değerler şunlardır: 'atExactScope()', 'policyType -eq {value}' veya 'category eq '{value}'. $filter sağlanmazsa, filtreleme yapılmaz. $filter=atExactScope() sağlanırsa, döndürülen liste yalnızca verilen kapsamdaki tüm ilke kümesi tanımlarını içerir. $filter='policyType -eq {value}' sağlanırsa, döndürülen liste yalnızca türü {value} ile eşleşen tüm ilke kümesi tanımlarını içerir. Olası policyType değerleri NotSpecified, BuiltIn, Custom ve Static değerleridir. $filter='category -eq {value}' sağlanırsa, döndürülen liste yalnızca kategorisi {value} ile eşleşen tüm ilke kümesi tanımlarını içerir.
$top	query		integer int32	Döndürülecek kayıt sayısı üst sınırı. $top filtresi sağlanmadığında 500 kayıt döndürür.

Yanıtlar

Name	Tür	Description
200 OK	PolicySetDefinitionListResult	Tamam - İlke kümesi tanımlarından oluşan bir dizi döndürür.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

List policy set definitions

Sample Request

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_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(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

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


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitions.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

Sample Response

Status code:

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",
            "policyDefinitionReferenceId": "RefId1"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
            "policyDefinitionReferenceId": "RefId2"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
            "policyDefinitionReferenceId": "RefId3"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
            "policyDefinitionReferenceId": "RefId4"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
            "policyDefinitionReferenceId": "RefId5"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
            "policyDefinitionReferenceId": "RefId6"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
            "policyDefinitionReferenceId": "RefId7"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
            "policyDefinitionReferenceId": "RefId8"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
            "policyDefinitionReferenceId": "RefId9"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
            "policyDefinitionReferenceId": "RefId10"
          }
        ]
      },
      "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "CostManagement",
      "properties": {
        "displayName": "Cost Management",
        "description": "Policies to enforce low cost storage SKUs",
        "metadata": {
          "category": "Cost Management"
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyDefinitions": [
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Tanımlar

Name	Description
CloudError	İlke işleminden bir hata yanıtı.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Hata Yanıtı
Metadata	parametresi için genel meta veriler.
ParameterDefinitionsValue	İlkeye sağlanabilir bir parametrenin tanımı.
parameterType	Parametrenin veri türü.
ParameterValuesValue	Parametrenin değeri.
PolicyDefinitionGroup	İlke tanımı grubu.
PolicyDefinitionReference	İlke tanımı başvurusu.
PolicySetDefinition	İlke kümesi tanımı.
PolicySetDefinitionListResult	İlke kümesi tanımlarının listesi.
policyType	İlke kümesi tanımının türü. Olası değerler NotSpecified, BuiltIn, Custom ve Static değerleridir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CloudError

İlke işleminden bir hata yanıtı.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorResponse

Hata Yanıtı

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

Metadata

parametresi için genel meta veriler.

Name	Tür	Description
assignPermissions	boolean	İlke ataması sırasında Azure portal bu parametrenin kaynak kimliğinde veya kaynak kapsamı değerinde rol atamaları oluşturmasını sağlamak için true olarak ayarlayın. Atama kapsamı dışında izinler atamak istemeniz durumunda bu özellik yararlıdır.
description	string	parametresinin açıklaması.
displayName	string	Parametrenin görünen adı.
strongType	string	portal aracılığıyla ilke tanımı atanırken kullanılır. Kullanıcının seçileceği değerlerin bağlam bilgisi olan bir listesi sağlar.

ParameterDefinitionsValue

İlkeye sağlanabilir bir parametrenin tanımı.

Name	Tür	Description
allowedValues	object[]	parametresi için izin verilen değerler.
defaultValue	object	Değer sağlanmazsa parametrenin varsayılan değeri.
metadata	Metadata	parametresi için genel meta veriler.
schema	object	Kendi kendine tanımlanmış bir JSON şeması kullanarak atama sırasında parametre girişlerinin doğrulanması sağlar. Bu özellik yalnızca nesne türü parametreler için desteklenir ve şema 2019-09 uygulamasını Json.NET izler. şemaları kullanma ve taslak şemaları https://json-schema.org/ test etme hakkında daha fazla bilgiyi adresinden https://www.jsonschemavalidator.net/edinebilirsiniz.
type	parameterType	Parametrenin veri türü.

parameterType

Parametrenin veri türü.

Name	Tür	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Parametrenin değeri.

Name	Tür	Description
value	object	Parametre değeri.

PolicyDefinitionGroup

İlke tanımı grubu.

Name	Tür	Description
additionalMetadataId	string	Grup hakkında ek meta veriler içeren bir kaynağın kaynak kimliği.
category	string	Grubun kategorisi.
description	string	Grubun açıklaması.
displayName	string	Grubun görünen adı.
name	string	Grubun adı.

PolicyDefinitionReference

İlke tanımı başvurusu.

Name	Tür	Description
groupNames	string[]	Bu ilke tanımı başvurusunun ait olduğu grupların adı.
parameters	<string,  ParameterValuesValue>	Başvuruda bulunan ilke kuralı için parametre değerleri. Anahtarlar parametre adlarıdır.
policyDefinitionId	string	İlke tanımının veya ilke kümesi tanımının kimliği.
policyDefinitionReferenceId	string	Bu ilke tanımı başvurusu için benzersiz bir kimlik (ilke kümesi tanımı içinde).

PolicySetDefinition

İlke kümesi tanımı.

Name	Tür	Description
id	string	İlke kümesi tanımının kimliği.
name	string	İlke kümesi tanımının adı.
properties.description	string	İlke kümesi tanım açıklaması.
properties.displayName	string	İlke kümesi tanımının görünen adı.
properties.metadata	object	İlke kümesi tanım meta verileri. Meta veriler açık uçlu bir nesnedir ve genellikle anahtar değer çiftlerinden oluşan bir koleksiyondur.
properties.parameters	<string,  ParameterDefinitionsValue>	İlke tanımı başvurularında kullanılabilecek ilke kümesi tanım parametreleri.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	İlke tanımı gruplarını açıklayan meta veriler, ilke kümesi tanımı içinde başvurur.
properties.policyDefinitions	PolicyDefinitionReference[]	İlke tanımı başvuru dizisi.
properties.policyType	policyType	İlke kümesi tanımının türü. Olası değerler NotSpecified, BuiltIn, Custom ve Static değerleridir.
properties.version	string	#.#.# biçiminde ilke kümesi tanım sürümü.
properties.versions	string[]	Bu ilke kümesi tanımı için kullanılabilir sürümlerin listesi.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

İlke kümesi tanımlarının listesi.

Name	Tür	Description
nextLink	string	Sonraki sonuç kümesini almak için kullanılacak URL.
value	PolicySetDefinition[]	İlke kümesi tanımları dizisi.

policyType

İlke kümesi tanımının türü. Olası değerler NotSpecified, BuiltIn, Custom ve Static değerleridir.

Name	Tür	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.