Policy Set Definitions - Get

Referenz

Dienst:: Policy

API-Version:: 2023-04-01

Ruft eine Richtliniensatzdefinition ab.
Dieser Vorgang ruft die Richtliniensatzdefinition im angegebenen Abonnement mit dem angegebenen Namen ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
policySetDefinitionName	path	True	string	Der Name der abzurufenden Richtliniensatzdefinition. RegEx-Muster: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
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".

Antworten

Name	Typ	Beschreibung
200 OK	PolicySetDefinition	OK – Gibt Informationen zur Richtliniensatzdefinition 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

Retrieve a policy set definition

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement?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 get_policy_set_definition.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.get(
        policy_set_definition_name="CostManagement",
    )
    print(response)


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

{
  "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"
    ],
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "displayName": "Cost Management Policies",
        "description": "Policies designed to control spend within a subscription."
      },
      {
        "name": "Organizational",
        "displayName": "Organizational Policies",
        "description": "Policies that help enforce resource organization standards within a subscription."
      }
    ],
    "policyDefinitions": [
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Limit_Skus",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "definitionVersion": "1.*.*",
        "policyDefinitionReferenceId": "Resource_Naming",
        "groupNames": [
          "Organizational"
        ],
        "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.
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.