Policy Definitions - List

Referencia

Service:: Policy

API Version:: 2023-04-01

Szabályzatdefiníciók lekérése egy előfizetésben
Ez a művelet lekéri egy adott előfizetés összes szabályzatdefiníciójának listáját, amely megfelel a választható $filter. A $filter érvényes értékei a következők: "atExactScope()", "policyType -eq {value}" vagy "category eq "{value}". Ha $filter nincs megadva, a szűretlen lista tartalmazza az előfizetéshez társított összes szabályzatdefiníciót, beleértve azokat is, amelyek közvetlenül vagy az adott előfizetést tartalmazó felügyeleti csoportokból származnak. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott előfizetésben lévő összes szabályzatdefiníciót tartalmazza. Ha $filter='policyType -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatdefiníciót tartalmazza, amelynek típusa megegyezik a(z) {value} értékkel. A policyType lehetséges értékei: NotSpecified, BuiltIn, Custom és Static. Ha $filter='category -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatdefiníciót tartalmazza, amelynek kategóriája megegyezik a(z) {value} értékkel.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string uuid	A cél-előfizetés azonosítója. Az értéknek UUID-nak kell lennie.
api-version	query	True	string	A művelethez használandó API-verzió.
$filter	query		string	A műveletre alkalmazandó szűrő. A $filter érvényes értékei a következők: "atExactScope()", "policyType -eq {value}" vagy "category eq "{value}". Ha $filter nincs megadva, a szűrés nem történik meg. Ha $filter=atExactScope() van megadva, a visszaadott lista csak az adott hatókörben lévő összes szabályzatdefiníciót tartalmazza. Ha $filter='policyType -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatdefiníciót tartalmazza, amelynek típusa megegyezik a(z) {value} értékkel. A policyType lehetséges értékei: NotSpecified, BuiltIn, Custom és Static. Ha $filter='category -eq {value}' van megadva, a visszaadott lista csak az összes olyan szabályzatdefiníciót tartalmazza, amelynek kategóriája megegyezik a(z) {value} értékkel.
$top	query		integer int32	A visszaadandó rekordok maximális száma. Ha a $top szűrő nincs megadva, 500 rekordot ad vissza.

Válaszok

Name	Típus	Description
200 OK	PolicyDefinitionListResult	OK – Szabályzatdefiníciók tömbjének visszaadása.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

List policy definitions by subscription

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions?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_policy_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_definitions.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyDefinitions.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": {
        "mode": "All",
        "displayName": "Allowed storage account SKUs",
        "policyType": "BuiltIn",
        "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.",
        "parameters": {
          "listOfAllowedSKUs": {
            "type": "Array",
            "metadata": {
              "description": "The list of SKUs that can be specified for storage accounts.",
              "displayName": "Allowed SKUs",
              "strongType": "StorageSKUs"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "allOf": [
              {
                "field": "type",
                "equals": "Microsoft.Storage/storageAccounts"
              },
              {
                "not": {
                  "field": "Microsoft.Storage/storageAccounts/sku.name",
                  "in": "[parameters('listOfAllowedSKUs')]"
                }
              }
            ]
          },
          "then": {
            "effect": "Deny"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "ResourceNaming"
    },
    {
      "properties": {
        "mode": "Microsoft.KeyVault.Data",
        "displayName": "Audit KeyVault certificates that expire within specified number of days",
        "description": "Audit certificates that are stored in Azure Key Vault, that expire within 'X' number of days.",
        "metadata": {
          "category": "KeyVault DataPlane"
        },
        "parameters": {
          "daysToExpire": {
            "type": "Integer",
            "metadata": {
              "displayName": "Days to expire",
              "description": "The number of days for a certificate to expire."
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "field": "Microsoft.KeyVault.Data/vaults/certificates/attributes/expiresOn",
            "lessOrEquals": "[addDays(utcNow(), parameters('daysToExpire'))]"
          },
          "then": {
            "effect": "audit"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/AuditSoonToExpireCerts",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "AuditSoonToExpireCerts"
    }
  ]
}

Definíciók

Name	Description
CloudError	Egy szabályzatművelet hibaválasza.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
Metadata	A paraméter általános metaadatai.
ParameterDefinitionsValue	A szabályzathoz megadható paraméter definíciója.
parameterType	A paraméter adattípusa.
PolicyDefinition	A szabályzatdefiníció.
PolicyDefinitionListResult	Szabályzatdefiníciók listája.
policyType	A szabályzatdefiníció típusa. Lehetséges értékek: NotSpecified, BuiltIn, Custom és Static.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

CloudError

Egy szabályzatművelet hibaválasza.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

Metadata

A paraméter általános metaadatai.

Name	Típus	Description
assignPermissions	boolean	Állítsa igaz értékre, hogy Azure Portal szerepkör-hozzárendeléseket hozzon létre a paraméter erőforrás-azonosítóján vagy erőforrás-hatókörének értékén a szabályzat-hozzárendelés során. Ez a tulajdonság akkor hasznos, ha a hozzárendelés hatókörén kívül szeretne engedélyeket hozzárendelni.
description	string	A paraméter leírása.
displayName	string	A paraméter megjelenítendő neve.
strongType	string	A szabályzatdefiníció portálon keresztüli hozzárendeléséhez használatos. A felhasználó számára kiválasztandó értékek környezetfüggő listáját tartalmazza.

ParameterDefinitionsValue

A szabályzathoz megadható paraméter definíciója.

Name	Típus	Description
allowedValues	object[]	A paraméter engedélyezett értékei.
defaultValue	object	A paraméter alapértelmezett értéke, ha nincs megadva érték.
metadata	Metadata	A paraméter általános metaadatai.
schema	object	A paraméterbemenetek ellenőrzését biztosítja a hozzárendelés során egy ön definiált JSON-sémával. Ez a tulajdonság csak objektumtípus-paraméterek esetén támogatott, és a Json.NET Schema 2019-09 implementációt követi. A sémák használatáról és a vázlatsémák https://json-schema.org/ teszteléséről a következő címen tudhat meg többet: https://www.jsonschemavalidator.net/.
type	parameterType	A paraméter adattípusa.

parameterType

A paraméter adattípusa.

Name	Típus	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string