Policy Restrictions - Check At Resource Group Scope
Überprüft, welche Einschränkungen Azure Policy für eine Ressource innerhalb einer Ressourcengruppe haben. Verwenden Sie dies, wenn die Ressourcengruppe, in der die Ressource erstellt wird, bereits bekannt ist.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
resourceDetails | True |
Die Informationen zu der Ressource, die ausgewertet wird. |
|
includeAuditEffect |
boolean |
Gibt an, ob Richtlinien mit dem "Audit"-Effekt in die Ergebnisse eingeschlossen werden sollen. Der Standardwert ist „false“. |
|
pendingFields |
Die Liste der Felder und Werte, die auf mögliche Einschränkungen ausgewertet werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Einschränkungen, die von Azure Policy für die Ressource festgelegt werden. |
|
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
Check policy restrictions at resource group scope |
Check policy restrictions at resource group scope including audit effect |
Check policy restrictions at resource group scope
Sample Request
POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/vmRg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01
{
"resourceDetails": {
"resourceContent": {
"type": "Microsoft.Compute/virtualMachines",
"properties": {
"priority": "Spot"
}
},
"apiVersion": "2019-12-01"
},
"pendingFields": [
{
"field": "name",
"values": [
"myVMName"
]
},
{
"field": "location",
"values": [
"eastus",
"westus",
"westus2",
"westeurope"
]
},
{
"field": "tags"
}
]
}
Sample Response
{
"fieldRestrictions": [
{
"field": "tags.newtag",
"restrictions": [
{
"result": "Required",
"defaultValue": "defaultVal",
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "tags.newtag is required"
}
]
},
{
"field": "tags.environment",
"restrictions": [
{
"result": "Required",
"values": [
"Prod",
"Int",
"Test"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "tags.environment is required"
}
]
},
{
"field": "location",
"restrictions": [
{
"result": "Deny",
"values": [
"west europe"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "location must be one of the following: eastus, westus, westus2"
},
{
"result": "Deny",
"values": [
"eastus",
"westus"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "location must be one of the following: westus2"
}
]
}
],
"contentEvaluationResult": {
"policyEvaluations": [
{
"policyInfo": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
"policyDefinitionReferenceId": "defref222",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
},
"evaluationResult": "NonCompliant",
"evaluationDetails": {
"evaluatedExpressions": [
{
"result": "True",
"expressionKind": "field",
"expression": "type",
"path": "type",
"expressionValue": "microsoft.compute/virtualmachines",
"targetValue": "microsoft.compute/virtualmachines",
"operator": "equals"
}
]
},
"effectDetails": {
"policyEffect": "Deny"
}
}
]
}
}
Check policy restrictions at resource group scope including audit effect
Sample Request
POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/vmRg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01
{
"resourceDetails": {
"resourceContent": {
"type": "Microsoft.Compute/virtualMachines",
"properties": {
"priority": "Spot"
}
},
"apiVersion": "2019-12-01"
},
"pendingFields": [
{
"field": "name",
"values": [
"myVMName"
]
},
{
"field": "location",
"values": [
"eastus",
"westus",
"westus2",
"westeurope"
]
},
{
"field": "tags"
}
],
"includeAuditEffect": true
}
Sample Response
{
"fieldRestrictions": [
{
"field": "tags.newtag",
"restrictions": [
{
"result": "Required",
"defaultValue": "defaultVal",
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "tags.newtag is required"
}
]
},
{
"field": "tags.environment",
"restrictions": [
{
"result": "Required",
"values": [
"Prod",
"Int",
"Test"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Audit",
"reason": "tags.environment is required"
}
]
},
{
"field": "location",
"restrictions": [
{
"result": "Deny",
"values": [
"west europe"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Deny",
"reason": "The selected location is not allowed"
},
{
"result": "Audit",
"values": [
"eastus",
"westus"
],
"policy": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
"policyDefinitionReferenceId": "DefRef"
},
"policyEffect": "Audit",
"reason": "The selected location is not allowed"
}
]
}
],
"contentEvaluationResult": {
"policyEvaluations": [
{
"policyInfo": {
"policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
"policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
"policyDefinitionReferenceId": "defref222",
"policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
},
"evaluationResult": "NonCompliant",
"evaluationDetails": {
"evaluatedExpressions": [
{
"result": "True",
"expressionKind": "field",
"expression": "type",
"path": "type",
"expressionValue": "microsoft.compute/virtualmachines",
"targetValue": "microsoft.compute/virtualmachines",
"operator": "equals"
}
],
"reason": "Resource creation of the selected type is not allowed"
},
"effectDetails": {
"policyEffect": "Audit"
}
}
]
}
}
Definitionen
Name | Beschreibung |
---|---|
Check |
Details zur Richtlinienauswertung. |
Check |
Die Parameter für Überprüfungsrichtlinieneinschränkungen, die die Ressource beschreiben, die ausgewertet wird. |
Check |
Die Informationen zu der Ressource, die ausgewertet wird. |
Check |
Das Ergebnis einer Auswertung von Überprüfungsrichtlinieneinschränkungen für eine Ressource. |
Content |
Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt. |
Error |
Fehlerdefinition. |
Error |
Fehlerantwort. |
Expression |
Auswertungsdetails von Richtliniensprachausdrücken. |
Field |
Die Einschränkungen für ein Feld, das von einer bestimmten Richtlinie auferlegt wird. |
Field |
Der Typ der Einschränkung, die dem Feld auferlegt wird. |
Field |
Die Einschränkungen, die für ein Feld in der Ressource nach Richtlinie festgelegt werden. |
If |
Auswertungsdetails des IfNotExists-Effekts. |
Pending |
Ein Feld, das anhand Azure Policy ausgewertet werden soll, um Einschränkungen zu bestimmen. |
Policy |
Die Details des Effekts, der auf die Ressource angewendet wurde. |
Policy |
Das Ergebnis einer nicht konformen Richtlinienauswertung für den angegebenen Ressourceninhalt. |
Policy |
Ressourcenbezeichner für eine Richtlinie. |
Typed |
Szenariospezifische Fehlerdetails. |
CheckRestrictionEvaluationDetails
Details zur Richtlinienauswertung.
Name | Typ | Beschreibung |
---|---|---|
evaluatedExpressions |
Details der ausgewerteten Ausdrücke. |
|
ifNotExistsDetails |
Auswertungsdetails des IfNotExists-Effekts. |
|
reason |
string |
Der Grund für das Auswertungsergebnis. |
CheckRestrictionsRequest
Die Parameter für Überprüfungsrichtlinieneinschränkungen, die die Ressource beschreiben, die ausgewertet wird.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
includeAuditEffect |
boolean |
False |
Gibt an, ob Richtlinien mit dem "Audit"-Effekt in die Ergebnisse eingeschlossen werden sollen. Der Standardwert ist „false“. |
pendingFields |
Die Liste der Felder und Werte, die auf mögliche Einschränkungen ausgewertet werden sollen. |
||
resourceDetails |
Die Informationen zu der Ressource, die ausgewertet wird. |
CheckRestrictionsResourceDetails
Die Informationen zu der Ressource, die ausgewertet wird.
Name | Typ | Beschreibung |
---|---|---|
apiVersion |
string |
Die API-Version des Ressourceninhalts. |
resourceContent |
object |
Der Ressourceninhalt. Dies sollte alle eigenschaften enthalten, die bereits bekannt sind, und kann ein Teilsatz aller Ressourceneigenschaften sein. |
scope |
string |
Der Bereich, in dem die Ressource erstellt wird. Wenn die Ressource beispielsweise eine untergeordnete Ressource ist, wäre dies die Ressourcen-ID der übergeordneten Ressource. |
CheckRestrictionsResult
Das Ergebnis einer Auswertung von Überprüfungsrichtlinieneinschränkungen für eine Ressource.
Name | Typ | Beschreibung |
---|---|---|
contentEvaluationResult |
Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt. |
|
fieldRestrictions |
Die Einschränkungen, die für verschiedene Felder in der Ressource nach Richtlinie festgelegt werden. |
ContentEvaluationResult
Auswertungsergebnisse für den bereitgestellten Teilressourceninhalt.
Name | Typ | Beschreibung |
---|---|---|
policyEvaluations |
Ergebnisse der Richtlinienauswertung für den angegebenen Ressourceninhalt. Dadurch wird angegeben, ob der bereitgestellte Teilinhalt unverändert verweigert wird. |
ErrorDefinition
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Zusätzliche szenariospezifische Fehlerdetails. |
|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
details |
Interne Fehlerdetails. |
|
message |
string |
Beschreibung des Fehlers |
target |
string |
Das Ziel des Fehlers. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
ExpressionEvaluationDetails
Auswertungsdetails von Richtliniensprachausdrücken.
Name | Typ | Beschreibung |
---|---|---|
expression |
string |
Ausdruck ausgewertet. |
expressionKind |
string |
Die Art des Ausdrucks, der ausgewertet wurde. |
expressionValue |
object |
Wert des Ausdrucks. |
operator |
string |
Operator zum Vergleichen des Ausdruckswerts und des Zielwerts. |
path |
string |
Eigenschaftspfad, wenn der Ausdruck ein Feld oder ein Alias ist. |
result |
string |
Auswertungsergebnis. |
targetValue |
object |
Zielwert, der mit dem Ausdruckswert verglichen werden soll. |
FieldRestriction
Die Einschränkungen für ein Feld, das von einer bestimmten Richtlinie auferlegt wird.
Name | Typ | Beschreibung |
---|---|---|
defaultValue |
string |
Der Wert, den die Richtlinie für das Feld festlegt, wenn der Benutzer keinen Wert bereitstellt. |
policy |
Die Details der Richtlinie, die die Feldeinschränkung verursacht. |
|
policyEffect |
string |
Die Auswirkung der Richtlinie, die die Feldeinschränkung verursacht. http://aka.ms/policyeffects |
reason |
string |
Der Grund für die Einschränkung. |
result |
Der Typ der Einschränkung, die dem Feld auferlegt wird. |
|
values |
string[] |
Die Werte, die von der Richtlinie für das Feld benötigt oder verweigert werden. |
FieldRestrictionResult
Der Typ der Einschränkung, die dem Feld auferlegt wird.
Name | Typ | Beschreibung |
---|---|---|
Audit |
string |
Das Feld und/oder die Werte werden von der Richtlinie überwacht. |
Deny |
string |
Das Feld und/oder die Werte werden von der Richtlinie verweigert. |
Removed |
string |
Das Feld wird von der Richtlinie entfernt. |
Required |
string |
Das Feld und/oder die Werte sind für die Richtlinie erforderlich. |
FieldRestrictions
Die Einschränkungen, die für ein Feld in der Ressource nach Richtlinie festgelegt werden.
Name | Typ | Beschreibung |
---|---|---|
field |
string |
Der Name des Felds. Dies kann eine Eigenschaft der obersten Ebene wie "name" oder "type" oder ein Azure Policy Feldalias sein. |
restrictions |
Die Einschränkungen, die für dieses Feld durch die Richtlinie gelten. |
IfNotExistsEvaluationDetails
Auswertungsdetails des IfNotExists-Effekts.
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
ID der zuletzt ausgewerteten Ressource für ifNotExists-Effekt. |
totalResources |
integer |
Gesamtanzahl der Ressourcen, für die die Existenzbedingung gilt. |
PendingField
Ein Feld, das anhand Azure Policy ausgewertet werden soll, um Einschränkungen zu bestimmen.
Name | Typ | Beschreibung |
---|---|---|
field |
string |
Der Name des Felds. Dies kann eine Eigenschaft der obersten Ebene wie "name" oder "type" oder ein Azure Policy Feldalias sein. |
values |
string[] |
Die Liste der potenziellen Werte für das Feld, das anhand Azure Policy ausgewertet werden soll. |
PolicyEffectDetails
Die Details des Effekts, der auf die Ressource angewendet wurde.
Name | Typ | Beschreibung |
---|---|---|
policyEffect |
string |
Der Effekt, der auf die Ressource angewendet wurde. http://aka.ms/policyeffects |
PolicyEvaluationResult
Das Ergebnis einer nicht konformen Richtlinienauswertung für den angegebenen Ressourceninhalt.
Name | Typ | Beschreibung |
---|---|---|
effectDetails |
Die Details des Effekts, der auf die Ressource angewendet wurde. |
|
evaluationDetails |
Die detaillierten Ergebnisse der ausgewerteten Richtlinienausdrücke und -werte. |
|
evaluationResult |
string |
Das Ergebnis der Richtlinienauswertung für die Ressource. Dies ist in der Regel "NonCompliant", kann jedoch andere Werte enthalten, wenn Fehler aufgetreten sind. |
policyInfo |
Die Details der ausgewerteten Richtlinie. |
PolicyReference
Ressourcenbezeichner für eine Richtlinie.
Name | Typ | Beschreibung |
---|---|---|
policyAssignmentId |
string |
Der Ressourcenbezeichner der Richtlinienzuweisung. |
policyDefinitionId |
string |
Der Ressourcenbezeichner der Richtliniendefinition. |
policyDefinitionReferenceId |
string |
Der Verweisbezeichner einer bestimmten Richtliniendefinition innerhalb einer Richtliniensatzdefinition. |
policySetDefinitionId |
string |
Der Ressourcenbezeichner der Richtliniensatzdefinition. |
TypedErrorInfo
Szenariospezifische Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
info |
Die szenariospezifischen Fehlerdetails. |
|
type |
string |
Der Typ der enthaltenen Fehlerdetails. |