Policy Set Definitions - List
Ruft die Richtliniensatzdefinitionen für ein Abonnement ab.
Dieser Vorgang ruft eine Liste aller Richtliniensatzdefinitionen in einem bestimmten Abonnement ab, die dem optionalen angegebenen $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 ungefilterte Liste alle Richtliniensatzdefinitionen, die dem Abonnement zugeordnet sind, einschließlich der Definitionen, die direkt oder aus Verwaltungsgruppen angewendet werden, die das angegebene Abonnement enthalten. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, die im angegebenen Abonnement enthalten sind. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Typ mit dem {value} übereinstimmt. 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 mit dem {value} übereinstimmt.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
subscription
|
path | True |
string uuid |
Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
$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 bereitgestellt wird, wird keine Filterung durchgeführt. Wenn $filter=atExactScope() angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, die sich im angegebenen Bereich befinden. Wenn $filter='policyType -eq {value}' angegeben wird, enthält die zurückgegebene Liste nur alle Richtliniensatzdefinitionen, deren Typ mit dem {value} übereinstimmt. 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 mit dem {value} übereinstimmt. |
|
$top
|
query |
integer int32 |
Maximale Anzahl von zurückzugebenden Datensätzen. Wenn der $top Filter nicht bereitgestellt wird, gibt er 500 Datensätze zurück. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK: Gibt ein Array von Richtliniensatzdefinitionen zurück. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
List policy set definitions
Sample Request
Sample Response
{
"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",
"policyDefinitionReferenceId": "RefId1"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
"policyDefinitionReferenceId": "RefId2"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
"policyDefinitionReferenceId": "RefId3"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
"policyDefinitionReferenceId": "RefId4"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
"policyDefinitionReferenceId": "RefId5"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
"policyDefinitionReferenceId": "RefId6"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
"policyDefinitionReferenceId": "RefId7"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
"policyDefinitionReferenceId": "RefId8"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
"policyDefinitionReferenceId": "RefId9"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
"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",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Cloud |
Eine Fehlerantwort eines Richtlinienvorgangs. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Fehlerantwort |
Metadata |
Allgemeine Metadaten für den Parameter. |
Parameter |
Die Definition eines Parameters, der für die Richtlinie bereitgestellt werden kann. |
parameter |
Der Datentyp des Parameters. |
Parameter |
Der Wert eines Parameters. |
Policy |
Die Richtliniendefinitionsgruppe. |
Policy |
Der Richtliniendefinitionsverweis. |
Policy |
Die Richtliniensatzdefinition. |
Policy |
Liste der Richtliniensatzdefinitionen. |
policy |
Der Typ der Richtliniensatzdefinition. Mögliche Werte sind NotSpecified, BuiltIn, Custom und Static. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
CloudError
Eine Fehlerantwort eines Richtlinienvorgangs.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerantwort |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
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 Azure-Portal während der Richtlinienzuweisung Rollenzuweisungen für die Ressourcen-ID oder den Ressourcenbereichswert dieses Parameters erstellen. Diese Eigenschaft ist hilfreich, wenn Sie Berechtigungen außerhalb des Zuweisungsbereichs 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 von Werten bereit, aus der der Benutzer auswählen kann. |
ParameterDefinitionsValue
Die Definition eines Parameters, der für die 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 |
Allgemeine Metadaten für den Parameter. |
|
schema |
object |
Ermöglicht die Validierung von Parametereingaben während der Zuweisung mithilfe eines selbst definierten JSON-Schemas. Diese Eigenschaft wird nur für Objekttypparameter unterstützt und folgt der 2019-09-Implementierung des Json.NET-Schemas. Weitere Informationen zur Verwendung von Schemas finden Sie unter https://json-schema.org/. Das Testen von Schemas ist unter https://www.jsonschemavalidator.net/ möglich. |
type |
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 zu der 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 |
---|---|---|
groupNames |
string[] |
Der Name der Gruppen, zu denen dieser Richtliniendefinitionsverweis gehört. |
parameters |
<string,
Parameter |
Die Parameterwerte für die Richtlinienregel, 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 Endobjekt und in der Regel eine Sammlung von Schlüsselwertpaaren. |
properties.parameters |
<string,
Parameter |
Die Richtliniensatzdefinitionsparameter, die in Richtliniendefinitionsverweisen verwendet werden können. |
properties.policyDefinitionGroups |
Die Metadaten, die Gruppen von Richtliniendefinitionsverweisen innerhalb der Richtliniensatzdefinition beschreiben. |
|
properties.policyDefinitions |
Ein Array von Richtliniendefinitionsverweisen. |
|
properties.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 |
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 |
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, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |