Policy Set Definitions - List By Management Group

Tjänst:

Policy

API-version:

2023-04-01

Hämtar alla principuppsättningsdefinitioner i hanteringsgruppen.
Den här åtgärden hämtar en lista över alla principuppsättningsdefinitioner i en viss hanteringsgrupp som matchar den valfria angivna $filter. Giltiga värden för $filter är: "atExactScope()", "policyType -eq {value}" eller "category eq '{value}'". Om $filter inte tillhandahålls innehåller den ofiltrerade listan alla principuppsättningsdefinitioner som är associerade med hanteringsgruppen, inklusive de som gäller direkt eller från hanteringsgrupper som innehåller den angivna hanteringsgruppen. Om $filter=atExactScope() tillhandahålls innehåller den returnerade listan endast alla principuppsättningsdefinitioner som finns i den angivna hanteringsgruppen. Om $filter='policyType -eq {value}' anges innehåller den returnerade listan endast alla principuppsättningsdefinitioner vars typ matchar {value}. Möjliga policyType-värden är NotSpecified, BuiltIn och Custom. Om $filter='category -eq {value}' anges innehåller den returnerade listan endast alla principuppsättningsdefinitioner vars kategori matchar {value}.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
managementGroupId	path	True	string	ID för hanteringsgruppen.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.
$expand	query		string	Kommaavgränsad lista över ytterligare egenskaper som ska ingå i svaret. Värden som stöds är "LatestDefinitionVersion, EffectiveDefinitionVersion".
$filter	query		string	Filtret som ska tillämpas på åtgärden. Giltiga värden för $filter är: "atExactScope()", "policyType -eq {value}" eller "category eq '{value}'". Om $filter inte tillhandahålls utförs ingen filtrering. Om $filter=atExactScope() tillhandahålls innehåller den returnerade listan endast alla principuppsättningsdefinitioner som finns i det angivna omfånget. Om $filter='policyType -eq {value}' anges innehåller den returnerade listan endast alla principuppsättningsdefinitioner vars typ matchar {value}. Möjliga policyType-värden är NotSpecified, BuiltIn, Custom och Static. Om $filter='category -eq {value}' anges innehåller den returnerade listan endast alla principuppsättningsdefinitioner vars kategori matchar {value}.
$top	query		integer int32	Maximalt antal poster som ska returneras. När filtret $top inte anges returneras 500 poster.

Svar

Name	Typ	Description
200 OK	PolicySetDefinitionListResult	OK – Returnerar en matris med definitioner för principuppsättningar.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List policy set definitions at management group level

Exempelbegäran

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

Exempelsvar

Statuskod:

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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definitioner

Name	Description
CloudError	Ett felsvar från en principåtgärd.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
Metadata	Allmänna metadata för parametern.
ParameterDefinitionsValue	Definitionen av en parameter som kan anges för principen.
parameterType	Parameterns datatyp.
ParameterValuesValue	Värdet för en parameter.
PolicyDefinitionGroup	Principdefinitionsgruppen.
PolicyDefinitionReference	Referensen för principdefinitionen.
PolicySetDefinition	Principuppsättningsdefinitionen.
PolicySetDefinitionListResult	Lista över definitioner för principuppsättningar.
policyType	Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
systemData	Metadata som rör skapande och senaste ändring av resursen.

CloudError

Ett felsvar från en principåtgärd.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.)

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

Metadata

Allmänna metadata för parametern.

Name	Typ	Description
assignPermissions	boolean	Ställ in på true om du vill att Azure-portalen ska skapa rolltilldelningar på resurs-ID:t eller resursomfångsvärdet för den här parametern under principtilldelningen. Den här egenskapen är användbar om du vill tilldela behörigheter utanför tilldelningsomfånget.
description	string	Beskrivningen av parametern.
displayName	string	Visningsnamnet för parametern.
strongType	string	Används när du tilldelar principdefinitionen via portalen. Innehåller en sammanhangsmedveten lista över värden som användaren kan välja mellan.

ParameterDefinitionsValue

Definitionen av en parameter som kan anges för principen.

Name	Typ	Description
allowedValues	object[]	De tillåtna värdena för parametern.
defaultValue	object	Standardvärdet för parametern om inget värde anges.
metadata	Metadata	Allmänna metadata för parametern.
schema	object	Tillhandahåller validering av parameterindata under tilldelningen med hjälp av ett självdefinierat JSON-schema. Den här egenskapen stöds endast för parametrar av objekttyp och följer implementeringen Json.NET Schema 2019-09. Du kan lära dig mer om att använda scheman på https://json-schema.org/ och testa utkastscheman på https://www.jsonschemavalidator.net/.
type	parameterType	Parameterns datatyp.

parameterType

Parameterns datatyp.

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

ParameterValuesValue

Värdet för en parameter.

Name	Typ	Description
value	object	Värdet för parametern.

PolicyDefinitionGroup

Principdefinitionsgruppen.

Name	Typ	Description
additionalMetadataId	string	Ett resurs-ID för en resurs som innehåller ytterligare metadata om gruppen.
category	string	Gruppens kategori.
description	string	Gruppens beskrivning.
displayName	string	Gruppens visningsnamn.
name	string	Namnet på gruppen.

PolicyDefinitionReference

Referensen för principdefinitionen.

Name	Typ	Description
definitionVersion	string	Den version av principdefinitionen som ska användas.
effectiveDefinitionVersion	string	Den effektiva versionen av principdefinitionen som används. Detta finns bara om det begärs via frågeparametern $expand.
groupNames	string[]	Namnet på de grupper som den här principdefinitionsreferensen tillhör.
latestDefinitionVersion	string	Den senaste versionen av den tillgängliga principdefinitionen. Detta finns bara om det begärs via frågeparametern $expand.
parameters	<string,  ParameterValuesValue>	Parametervärdena för den refererade principregeln. Nycklarna är parameternamnen.
policyDefinitionId	string	ID:t för principdefinitionen eller principuppsättningsdefinitionen.
policyDefinitionReferenceId	string	Ett unikt ID (inom principuppsättningsdefinitionen) för den här principdefinitionsreferensen.

PolicySetDefinition

Principuppsättningsdefinitionen.

Name	Typ	Description
id	string	ID:t för principuppsättningsdefinitionen.
name	string	Namnet på principuppsättningsdefinitionen.
properties.description	string	Definitionsbeskrivningen för principuppsättningen.
properties.displayName	string	Visningsnamnet för principuppsättningsdefinitionen.
properties.metadata	object	Definitionsmetadata för principuppsättningen. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
properties.parameters	<string,  ParameterDefinitionsValue>	Definitionsparametrar för principuppsättningar som kan användas i principdefinitionsreferenser.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	Metadata som beskriver grupper av principdefinitionsreferenser i principuppsättningsdefinitionen.
properties.policyDefinitions	PolicyDefinitionReference[]	En matris med principdefinitionsreferenser.
properties.policyType	policyType	Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.
properties.version	string	Principuppsättningens definitionsversion i #.#.#-format.
properties.versions	string[]	En lista över tillgängliga versioner för den här principuppsättningsdefinitionen.
systemData	systemData	Systemmetadata för den här resursen.
type	string	Resurstypen (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

Lista över definitioner för principuppsättningar.

Name	Typ	Description
nextLink	string	Den URL som ska användas för att hämta nästa uppsättning resultat.
value	PolicySetDefinition[]	En matris med principuppsättningsdefinitioner.

policyType

Typ av principuppsättningsdefinition. Möjliga värden är NotSpecified, BuiltIn, Custom och Static.

Name	Typ	Description
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.