Policy Set Definitions - List By Management Group

Usługa:

Policy

Wersja interfejsu API:

2023-04-01

Pobiera wszystkie definicje zestawu zasad w grupie zarządzania.
Ta operacja pobiera listę wszystkich definicji zestawu zasad w danej grupie zarządzania, która jest zgodna z opcjonalnym danym $filter. Prawidłowe wartości dla $filter to: "atExactScope()", "policyType -eq {value}" lub "category eq "{value}". Jeśli $filter nie zostanie podana, lista niefiltrowana zawiera wszystkie definicje zestawu zasad skojarzone z grupą zarządzania, w tym te, które mają zastosowanie bezpośrednio lub z grup zarządzania zawierających daną grupę zarządzania. Jeśli zostanie podana $filter=atExactScope(), zwracana lista zawiera tylko wszystkie definicje zestawu zasad, które znajdują się w danej grupie zarządzania. Jeśli podano $filter='policyType -eq {value}", zwracana lista zawiera tylko wszystkie definicje zestawu zasad, których typ jest zgodny z {value}. Możliwe wartości policyType to NotSpecified, BuiltIn i Custom. Jeśli zostanie podana $filter='category -eq {value}", zwracana lista zawiera tylko wszystkie definicje zestawu zasad, których kategoria jest zgodna z {value}.

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

Z parametrami opcjonalnymi:

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
managementGroupId	path	True	string	Identyfikator grupy zarządzania.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi. Obsługiwane wartości to "LatestDefinitionVersion, EffectiveDefinitionVersion".
$filter	query		string	Filtr do zastosowania w operacji. Prawidłowe wartości dla $filter to: "atExactScope()", "policyType -eq {value}" lub "category eq "{value}". Jeśli nie podano $filter, nie jest wykonywane filtrowanie. Jeśli zostanie podana $filter=atExactScope(), zwracana lista zawiera tylko wszystkie definicje zestawu zasad, które znajdują się w danym zakresie. Jeśli podano $filter='policyType -eq {value}", zwracana lista zawiera tylko wszystkie definicje zestawu zasad, których typ jest zgodny z {value}. Możliwe wartości policyType to NotSpecified, BuiltIn, Custom i Static. Jeśli zostanie podana $filter='category -eq {value}", zwracana lista zawiera tylko wszystkie definicje zestawu zasad, których kategoria jest zgodna z {value}.
$top	query		integer int32	Maksymalna liczba rekordów do zwrócenia. Jeśli filtr $top nie zostanie podany, zwróci 500 rekordów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PolicySetDefinitionListResult	OK — zwraca tablicę definicji zestawu zasad.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List policy set definitions at management group level

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z operacji zasad.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
Metadata	Ogólne metadane parametru.
ParameterDefinitionsValue	Definicja parametru, który można podać do zasad.
parameterType	Typ danych parametru.
ParameterValuesValue	Wartość parametru.
PolicyDefinitionGroup	Grupa definicji zasad.
PolicyDefinitionReference	Odwołanie do definicji zasad.
PolicySetDefinition	Definicja zestawu zasad.
PolicySetDefinitionListResult	Lista definicji zestawu zasad.
policyType	Typ definicji zestawu zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Odpowiedź na błąd z operacji zasad.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

Metadata

Ogólne metadane parametru.

Nazwa	Typ	Opis
assignPermissions	boolean	Ustaw wartość true, aby witryna Azure Portal utworzyła przypisania ról dla identyfikatora zasobu lub wartości zakresu zasobu tego parametru podczas przypisywania zasad. Ta właściwość jest przydatna w przypadku, gdy chcesz przypisać uprawnienia poza zakresem przypisania.
description	string	Opis parametru.
displayName	string	Nazwa wyświetlana parametru.
strongType	string	Używane podczas przypisywania definicji zasad za pośrednictwem portalu. Udostępnia kontekstową listę wartości do wyboru przez użytkownika.

ParameterDefinitionsValue

Definicja parametru, który można podać do zasad.

Nazwa	Typ	Opis
allowedValues	object[]	Dozwolone wartości parametru.
defaultValue	object	Wartość domyślna parametru, jeśli nie podano żadnej wartości.
metadata	Metadata	Ogólne metadane parametru.
schema	object	Zapewnia walidację danych wejściowych parametrów podczas przypisywania przy użyciu schematu JSON zdefiniowanego samodzielnie. Ta właściwość jest obsługiwana tylko dla parametrów typu obiektu i jest zgodna z implementacją Json.NET Schema 2019-09. Aby dowiedzieć się więcej na temat używania schematów, zobacz https://json-schema.org/ i testowanie schematów roboczych w witrynie https://www.jsonschemavalidator.net/.
type	parameterType	Typ danych parametru.

parameterType

Typ danych parametru.

Nazwa	Typ	Opis
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Wartość parametru.

Nazwa	Typ	Opis
value	object	Wartość parametru.

PolicyDefinitionGroup

Grupa definicji zasad.

Nazwa	Typ	Opis
additionalMetadataId	string	Identyfikator zasobu, który zawiera dodatkowe metadane dotyczące grupy.
category	string	Kategoria grupy.
description	string	Opis grupy.
displayName	string	Nazwa wyświetlana grupy.
name	string	Nazwa grupy.

PolicyDefinitionReference

Odwołanie do definicji zasad.

Nazwa	Typ	Opis
definitionVersion	string	Wersja definicji zasad do użycia.
effectiveDefinitionVersion	string	Obowiązująca wersja definicji zasad w użyciu. Jest to obecne tylko w przypadku żądania za pośrednictwem parametru zapytania $expand.
groupNames	string[]	Nazwa grup, do których należy odwołanie do tej definicji zasad.
latestDefinitionVersion	string	Dostępna jest najnowsza wersja definicji zasad. Jest to obecne tylko w przypadku żądania za pośrednictwem parametru zapytania $expand.
parameters	<string,  ParameterValuesValue>	Wartości parametrów dla reguły zasad, do których odwołuje się odwołanie. Klucze są nazwami parametrów.
policyDefinitionId	string	Identyfikator definicji zasad lub definicji zestawu zasad.
policyDefinitionReferenceId	string	Unikatowy identyfikator (w definicji zestawu zasad) dla tej definicji zasad.

PolicySetDefinition

Definicja zestawu zasad.

Nazwa	Typ	Opis
id	string	Identyfikator definicji zestawu zasad.
name	string	Nazwa definicji zestawu zasad.
properties.description	string	Opis definicji zestawu zasad.
properties.displayName	string	Nazwa wyświetlana definicji zestawu zasad.
properties.metadata	object	Metadane definicji zestawu zasad. Metadane są otwartym obiektem końcowym i zazwyczaj jest kolekcją par klucz-wartość.
properties.parameters	<string,  ParameterDefinitionsValue>	Parametry definicji zestawu zasad, które mogą być używane w odwołaniach definicji zasad.
properties.policyDefinitionGroups	PolicyDefinitionGroup[]	Metadane opisujące grupy odwołań definicji zasad w definicji zestawu zasad.
properties.policyDefinitions	PolicyDefinitionReference[]	Tablica odwołań definicji zasad.
properties.policyType	policyType	Typ definicji zestawu zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static.
properties.version	string	Wersja definicji zestawu zasad w formacie #.#.#
properties.versions	string[]	Lista dostępnych wersji dla tej definicji zestawu zasad.
systemData	systemData	Metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu (Microsoft.Authorization/policySetDefinitions).

PolicySetDefinitionListResult

Lista definicji zestawu zasad.

Nazwa	Typ	Opis
nextLink	string	Adres URL używany do pobierania następnego zestawu wyników.
value	PolicySetDefinition[]	Tablica definicji zestawu zasad.

policyType

Typ definicji zestawu zasad. Możliwe wartości to NotSpecified, BuiltIn, Custom i Static.

Nazwa	Typ	Opis
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.