Policy Set Definitions - List By Management Group

Dienst:

Policy

API-Version:

2023-04-01

Ruft alle Richtliniensatzdefinitionen in der Verwaltungsgruppe ab.
Dieser Vorgang ruft eine Liste aller Richtliniensatzdefinitionen in einer bestimmten Verwaltungsgruppe ab, die dem optionalen $filter entsprechen. Gültige Werte für $filter sind: 'atExactScope()', 'policyType -eq {value}' oder 'category eq '{value}'. Wenn $filter nicht bereitgestellt wird, enthält die nicht gefilterte Liste alle Richtliniensatzdefinitionen, die der Verwaltungsgruppe zugeordnet sind, einschließlich derJenigen, die direkt oder aus Verwaltungsgruppen angewendet werden, die die angegebene Verwaltungsgruppe enthalten. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, die sich in der angegebenen Verwaltungsgruppe befinden. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Typ dem {value} entspricht. Mögliche PolicyType-Werte sind NotSpecified, BuiltIn und Custom. Wenn $filter='category -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Kategorie dem {wert} entspricht.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
managementGroupId	path	True	string	Die ID der Verwaltungsgruppe.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Durch Trennzeichen getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Unterstützte Werte sind "LatestDefinitionVersion, EffectiveDefinitionVersion".
$filter	query		string	Der filter, der auf den Vorgang angewendet werden soll. Gültige Werte für $filter sind: 'atExactScope()', 'policyType -eq {value}' oder 'category eq '{value}'. Wenn $filter nicht angegeben wird, wird keine Filterung ausgeführt. Wenn $filter=atExactScope() bereitgestellt wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, die im angegebenen Bereich enthalten sind. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Typ dem {value} entspricht. Mögliche PolicyType-Werte sind NotSpecified, BuiltIn, Custom und Static. Wenn $filter='category -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Kategorie dem {wert} entspricht.
$top	query		integer int32	Maximale Anzahl der zurückzugebenden Datensätze. Wenn der $top Filter nicht angegeben wird, gibt er 500 Datensätze zurück.

Antworten

Name	Typ	Beschreibung
200 OK	PolicySetDefinitionListResult	OK : Gibt ein Array von Richtliniensatzdefinitionen zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List policy set definitions at management group level

Beispielanforderung

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/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_by_management_group.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_by_management_group(
        management_group_id="MyManagementGroup",
    )
    for item in response:
        print(item)


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

Beispiel für eine Antwort

Statuscode:

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",
            "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",
            "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": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort eines Richtlinienvorgangs.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
Metadata	Allgemeine Metadaten für den Parameter.
ParameterDefinitionsValue	Die Definition eines Parameters, der der Richtlinie bereitgestellt werden kann.
parameterType	Der Datentyp des Parameters.
ParameterValuesValue	Der Wert eines Parameters.
PolicyDefinitionGroup	Die Richtliniendefinitionsgruppe.
PolicyDefinitionReference	Der Richtliniendefinitionsverweis.
PolicySetDefinition	Die Richtliniensatzdefinition.
PolicySetDefinitionListResult	Liste der Richtliniensatzdefinitionen.
policyType	Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Eine Fehlerantwort eines Richtlinienvorgangs.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Metadata

Allgemeine Metadaten für den Parameter.

Name	Typ	Beschreibung
assignPermissions	boolean	Legen Sie diesen Wert auf "true" fest, damit das Azure-Portal Während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellt. Diese Eigenschaft ist nützlich, falls Sie Berechtigungen außerhalb des Zuordnungsbereichs zuweisen möchten.
description	string	Die Beschreibung des Parameters.
displayName	string	Der Anzeigename für den Parameter.
strongType	string	Wird beim Zuweisen der Richtliniendefinition über das Portal verwendet. Stellt eine kontextbezogene Liste mit Werten bereit, aus der der Benutzer auswählen kann.

ParameterDefinitionsValue

Die Definition eines Parameters, der der Richtlinie bereitgestellt werden kann.

Name	Typ	Beschreibung
allowedValues	object[]	Die zulässigen Werte für den Parameter.
defaultValue	object	Der Standardwert für den Parameter, wenn kein Wert angegeben wird.
metadata	Metadata	Allgemeine Metadaten für den Parameter.
schema	object	Stellt die Überprüfung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas bereit. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der Json.NET Schema 2019-09-Implementierung. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/ und Testentwurfsschemas unter https://www.jsonschemavalidator.net/.
type	parameterType	Der Datentyp des Parameters.

parameterType

Der Datentyp des Parameters.

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

ParameterValuesValue

Der Wert eines Parameters.

Name	Typ	Beschreibung
value	object	Der Wert des Parameters.

PolicyDefinitionGroup

Die Richtliniendefinitionsgruppe.

Name	Typ	Beschreibung
additionalMetadataId	string	Eine Ressourcen-ID einer Ressource, die zusätzliche Metadaten zur Gruppe enthält.
category	string	Die Kategorie der Gruppe.
description	string	Die Beschreibung der Gruppe.
displayName	string	Der Anzeigename der Gruppe.
name	string	Der Name der Gruppe.

PolicyDefinitionReference

Der Richtliniendefinitionsverweis.

Name	Typ	Beschreibung
definitionVersion	string	Die Version der zu verwendenden Richtliniendefinition.
effectiveDefinitionVersion	string	Die effektive Version der verwendeten Richtliniendefinition. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
groupNames	string[]	Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört.
latestDefinitionVersion	string	Die neueste Version der verfügbaren Richtliniendefinition. Dies ist nur vorhanden, wenn sie über den $expand Abfrageparameter angefordert wird.
parameters	<string,  ParameterValuesValue>	Die Parameterwerte für die Regel, auf die verwiesen wird. Die Schlüssel sind die Parameternamen.
policyDefinitionId	string	Die ID der Richtliniendefinition oder Richtliniensatzdefinition.
policyDefinitionReferenceId	string	Eine eindeutige ID (innerhalb der Richtliniensatzdefinition) für diese Richtliniendefinitionsreferenz.

PolicySetDefinition

Die Richtliniensatzdefinition.

Name	Typ	Beschreibung
id	string	Die ID der Richtliniensatzdefinition.
name	string	Der Name der Richtliniensatzdefinition.
properties.description	string	Die Beschreibung der Richtliniensatzdefinition.
properties.displayName	string	Der Anzeigename der Richtliniensatzdefinition.
properties.metadata	object	Die Metadaten der Richtliniensatzdefinition. Metadaten sind ein offenes beendetes Objekt und sind in der Regel eine Sammlung von Schlüsselwertpaaren.
properties.parameters	<string,  ParameterDefinitionsValue>	Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsreferenzen verwendet werden können.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben.
properties.policyDefinitions	PolicyDefinitionReference[]	Ein Array von Richtliniendefinitionsverweisen.
properties.policyType	policyType	Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.
properties.version	string	Die Definitionsversion des Richtliniensatzes im #.#.#-Format.
properties.versions	string[]	Eine Liste der verfügbaren Versionen für diese Richtliniensatzdefinition.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

Liste der Richtliniensatzdefinitionen.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	PolicySetDefinition[]	Ein Array von Richtliniensatzdefinitionen.

policyType

Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static.

Name	Typ	Beschreibung
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.