Policy Set Definitions - List

Služba:

Policy

Verze rozhraní API:

2023-04-01

Načte definice sady zásad pro předplatné.
Tato operace načte seznam všech definic sady zásad v daném předplatném, které odpovídají volitelnému $filter. Platné hodnoty pro $filter jsou: 'atExactScope()', 'policyType -eq {value} nebo 'category eq '{value}'. Pokud $filter není k dispozici, obsahuje nefiltrovaný seznam všechny definice sady zásad přidružené k předplatnému, včetně těch, které se vztahují přímo nebo ze skupin pro správu, které obsahují dané předplatné. Pokud je k dispozici $filter=atExactScope(), vrácený seznam obsahuje pouze všechny definice sady zásad, které jsou v daném předplatném. Pokud je zadán $filter='policyType -eq {value}', bude vrácený seznam obsahovat pouze všechny definice sady zásad, jejichž typ odpovídá hodnotě {value}. Možné hodnoty policyType jsou NotSpecified, BuiltIn a Custom. Pokud je zadaný $filter='category -eq {value}', bude vrácený seznam obsahovat pouze všechny definice sady zásad, jejichž kategorie odpovídá {value}.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Čárkami oddělený seznam dalších vlastností, které se mají zahrnout do odpovědi. Podporované hodnoty jsou LatestDefinitionVersion, EffectiveDefinitionVersion.
$filter	query		string	Filtr, který se má použít pro operaci. Platné hodnoty pro $filter jsou: 'atExactScope()', 'policyType -eq {value} nebo 'category eq '{value}'. Pokud $filter není k dispozici, neprovádí se žádné filtrování. Pokud je k dispozici $filter=atExactScope(), vrácený seznam obsahuje pouze všechny definice sady zásad, které v daném oboru. Pokud je zadán $filter='policyType -eq {value}', bude vrácený seznam obsahovat pouze všechny definice sady zásad, jejichž typ odpovídá hodnotě {value}. Možné hodnoty policyType jsou NotSpecified, BuiltIn, Custom a Static. Pokud je zadaný $filter='category -eq {value}', bude vrácený seznam obsahovat pouze všechny definice sady zásad, jejichž kategorie odpovídá {value}.
$top	query		integer int32	Maximální počet záznamů, které se mají vrátit. Pokud filtr $top není zadaný, vrátí 500 záznamů.

Odpovědi

Name	Typ	Description
200 OK	PolicySetDefinitionListResult	OK – Vrátí pole definic sady zásad.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List policy set definitions

Ukázkový požadavek

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(),
        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

Ukázková odpověď

Stavový kód:

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"
    },
    {
      "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",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
CloudError	Odpověď na chybu operace zásad.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
Metadata	Obecná metadata parametru
ParameterDefinitionsValue	Definice parametru, který lze poskytnout zásadám.
parameterType	Datový typ parametru.
ParameterValuesValue	Hodnota parametru.
PolicyDefinitionGroup	Skupina definic zásad.
PolicyDefinitionReference	Referenční informace k definici zásad.
PolicySetDefinition	Definice sady zásad.
PolicySetDefinitionListResult	Seznam definic sady zásad
policyType	Typ definice sady zásad. Možné hodnoty jsou NotSpecified, BuiltIn, Custom a Static.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Odpověď na chybu operace zásad.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

Metadata

Obecná metadata parametru

Name	Typ	Description
assignPermissions	boolean	Pokud chcete, aby azure Portal při přiřazování zásad vytvářelo přiřazení rolí pro ID prostředku nebo hodnotu oboru prostředku tohoto parametru. Tato vlastnost je užitečná v případě, že chcete přiřadit oprávnění mimo obor přiřazení.
description	string	Popis parametru.
displayName	string	Zobrazovaný název parametru.
strongType	string	Používá se při přiřazování definice zásady prostřednictvím portálu. Poskytuje kontextový seznam hodnot, ze které si uživatel může vybrat.

ParameterDefinitionsValue

Definice parametru, který lze poskytnout zásadám.

Name	Typ	Description
allowedValues	object[]	Povolené hodnoty parametru.
defaultValue	object	Výchozí hodnota parametru, pokud není zadaná žádná hodnota.
metadata	Metadata	Obecná metadata parametru
schema	object	Poskytuje ověřování vstupů parametrů během přiřazení pomocí schématu JSON definovaného vlastním kódem. Tato vlastnost je podporována pouze pro parametry typu objektu a řídí se implementací Json.NET Schema 2019-09. Další informace o používání schémat najdete v tématu https://json-schema.org/ a testování konceptů schémat na https://www.jsonschemavalidator.net/.
type	parameterType	Datový typ parametru.

parameterType

Datový typ parametru.

Name	Typ	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Hodnota parametru.

Name	Typ	Description
value	object	Hodnota parametru.

PolicyDefinitionGroup

Skupina definic zásad.

Name	Typ	Description
additionalMetadataId	string	ID prostředku prostředku, který obsahuje další metadata o skupině.
category	string	Kategorie skupiny.
description	string	Popis skupiny.
displayName	string	Zobrazovaný název skupiny.
name	string	Název skupiny.

PolicyDefinitionReference

Referenční informace k definici zásad.

Name	Typ	Description
definitionVersion	string	Verze definice zásady, která se má použít.
effectiveDefinitionVersion	string	Platná verze definice zásady, která se používá. Tato možnost se vyskytuje pouze v případě, že se požaduje prostřednictvím parametru dotazu $expand.
groupNames	string[]	Název skupin, do nichž patří tento odkaz na definici zásad.
latestDefinitionVersion	string	K dispozici je nejnovější verze definice zásady. Tato možnost se vyskytuje pouze v případě, že se požaduje prostřednictvím parametru dotazu $expand.
parameters	<string,  ParameterValuesValue>	Hodnoty parametrů pro odkazované pravidlo zásad. Klíče jsou názvy parametrů.
policyDefinitionId	string	ID definice zásady nebo definice sady zásad.
policyDefinitionReferenceId	string	Jedinečné ID (v definici sady zásad) pro tento odkaz na definici zásady.

PolicySetDefinition

Definice sady zásad.

Name	Typ	Description
id	string	ID definice sady zásad.
name	string	Název definice sady zásad.
properties.description	string	Popis definice sady zásad.
properties.displayName	string	Zobrazovaný název definice sady zásad.
properties.metadata	object	Metadata definice sady zásad. Metadata jsou otevřený objekt, který je obvykle kolekcí párů klíč-hodnota.
properties.parameters	<string,  ParameterDefinitionsValue>	Parametry definice sady zásad, které lze použít v odkazech na definici zásad.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	Metadata popisující skupiny odkazů na definice zásad v definici sady zásad.
properties.policyDefinitions	PolicyDefinitionReference[]	Pole odkazů na definice zásad.
properties.policyType	policyType	Typ definice sady zásad. Možné hodnoty jsou NotSpecified, BuiltIn, Custom a Static.
properties.version	string	Verze definice sady zásad ve formátu #.#.#
properties.versions	string[]	Seznam dostupných verzí pro tuto definici sady zásad.
systemData	systemData	Systémová metadata týkající se tohoto prostředku.
type	string	Typ prostředku (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

Seznam definic sady zásad

Name	Typ	Description
nextLink	string	Adresa URL, která se má použít k získání další sady výsledků.
value	PolicySetDefinition[]	Pole definic sady zásad.

policyType

Typ definice sady zásad. Možné hodnoty jsou NotSpecified, BuiltIn, Custom a Static.

Name	Typ	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.