Policy States - List Query Results For Resource Group Level Policy Assignment
Lekérdezi az erőforráscsoportszintű szabályzat-hozzárendelés szabályzatállapotait.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
authorization
|
path | True |
A Microsoft Engedélyezési erőforrás-szolgáltató névtere; csak a "Microsoft.Authorization" engedélyezett. |
|
policy
|
path | True |
string |
Szabályzat-hozzárendelés neve. |
policy
|
path | True |
A PolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok), míg az "alapértelmezett" az összes szabályzatállapotot jelöli. |
|
resource
|
path | True |
string |
Az erőforráscsoport neve. |
subscription
|
path | True |
string |
Microsoft Azure-előfizetés azonosítója. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
$apply
|
query |
string |
Az OData kifejezéseket alkalmaz az összesítésekhez. |
|
$filter
|
query |
string |
OData szűrőkifejezés. |
|
$from
|
query |
string date-time |
ISO 8601 formátumú időbélyeg, amely a lekérdezési időköz kezdő időpontját adja meg. Ha nincs megadva, a szolgáltatás ($to - 1 nap) használ. |
|
$orderby
|
query |
string |
Kifejezés rendezése OData-jelöléssel. Egy vagy több vesszővel tagolt oszlopnév opcionális "desc" (alapértelmezett) vagy "asc" névvel, például "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Válassza ki a kifejezést OData-jelöléssel. Az egyes rekordok oszlopait csak a kért értékekre korlátozza, például "$select=PolicyAssignmentId, ResourceId". |
|
$skiptoken
|
query |
string |
A Skiptoken csak akkor érhető el, ha egy korábbi válasz részleges eredményt adott vissza a nextLink elem részeként. |
|
$to
|
query |
string date-time |
ISO 8601 formátumú időbélyeg, amely megadja a lekérdezési időköz befejezési idejét. Ha nincs megadva, a szolgáltatás kérési időt használ. |
|
$top
|
query |
integer int32 |
A visszaadandó rekordok maximális száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Lekérdezési eredmények. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Query latest at resource group level policy assignment scope |
Query latest at resource group level policy assignment scope with next link |
Query latest at resource group level policy assignment scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": null,
"policyAssignmentVersion": "1.0.0"
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": null,
"policyAssignmentVersion": "1.0.0"
}
]
}
Query latest at resource group level policy assignment scope with next link
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"policyDefinitionGroupNames": [
"myGroup"
]
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
]
}
]
}
Definíciók
Name | Description |
---|---|
Authorization |
A Microsoft Engedélyezési erőforrás-szolgáltató névtere; csak a "Microsoft.Authorization" engedélyezett. |
Component |
Összetevő állapotának részletei. |
Error |
Hibadefiníció. |
Expression |
A szabályzatnyelvi kifejezések kiértékelési részletei. |
If |
Az IfNotExists hatás kiértékelési részletei. |
Policy |
Szabályzatértékelés részletei. |
Policy |
Szabályzatállapot rekordja. |
Policy |
Lekérdezési eredmények. |
Policy |
A PolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok), míg az "alapértelmezett" az összes szabályzatállapotot jelöli. |
Query |
Hibaválasz. |
AuthorizationNamespaceType
A Microsoft Engedélyezési erőforrás-szolgáltató névtere; csak a "Microsoft.Authorization" engedélyezett.
Name | Típus | Description |
---|---|---|
Microsoft.Authorization |
string |
ComponentStateDetails
Összetevő állapotának részletei.
Name | Típus | Description |
---|---|---|
complianceState |
string |
Összetevő megfelelőségi állapota. |
id |
string |
Összetevő azonosítója. |
name |
string |
Összetevő neve. |
timestamp |
string |
Összetevő-megfelelőség kiértékelési időbélyege. |
type |
string |
Alkatrésztípus. |
Error
Hibadefiníció.
Name | Típus | Description |
---|---|---|
code |
string |
Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál. |
message |
string |
A hiba leírása. |
ExpressionEvaluationDetails
A szabályzatnyelvi kifejezések kiértékelési részletei.
Name | Típus | Description |
---|---|---|
expression |
string |
Kifejezés kiértékelve. |
expressionKind |
string |
A kiértékelt kifejezés típusa. |
expressionValue |
object |
A kifejezés értéke. |
operator |
string |
Operátor a kifejezésérték és a célérték összehasonlításához. |
path |
string |
Tulajdonság elérési útja, ha a kifejezés mező vagy alias. |
result |
string |
Kiértékelési eredmény. |
targetValue |
object |
A kifejezés értékével összehasonlítandó célérték. |
IfNotExistsEvaluationDetails
Az IfNotExists hatás kiértékelési részletei.
Name | Típus | Description |
---|---|---|
resourceId |
string |
Az IfNotExists effektus utolsó kiértékelt erőforrásának azonosítója. |
totalResources |
integer |
Azon erőforrások teljes száma, amelyekre a létezési feltétel alkalmazható. |
PolicyEvaluationDetails
Szabályzatértékelés részletei.
Name | Típus | Description |
---|---|---|
evaluatedExpressions |
A kiértékelt kifejezések részletei. |
|
ifNotExistsDetails |
Az IfNotExists hatás kiértékelési részletei. |
PolicyState
Szabályzatállapot rekordja.
Name | Típus | Description |
---|---|---|
@odata.context |
string |
OData környezeti sztring; az OData-ügyfelek használják a típusadatok metaadatokon alapuló feloldására. |
@odata.id |
string |
OData-entitás azonosítója; mindig null értékre van állítva, mivel a szabályzatállapotrekordok nem rendelkeznek entitásazonosítóval. |
complianceState |
string |
Az erőforrás megfelelőségi állapota. |
components |
Az összetevők állapotmegfelelési rekordjai csak akkor lesznek kitöltve, ha az URL-cím $expand=components záradékot tartalmaz. |
|
effectiveParameters |
string |
A szabályzat-hozzárendelés hatályos paraméterei. |
isCompliant |
boolean |
Annak megjelölése, hogy az erőforrás megfelel-e a kiértékelt szabályzat-hozzárendelésnek. Ez a tulajdonság elavult; használja inkább a ComplianceState parancsot. |
managementGroupIds |
string |
A felügyeleti csoport azonosítóinak vesszővel tagolt listája, amely az erőforrás alá tartozó felügyeleti csoportok hierarchiáját jelöli. |
policyAssignmentId |
string |
Szabályzat-hozzárendelés azonosítója. |
policyAssignmentName |
string |
Szabályzat-hozzárendelés neve. |
policyAssignmentOwner |
string |
Szabályzat-hozzárendelés tulajdonosa. |
policyAssignmentParameters |
string |
Szabályzat-hozzárendelési paraméterek. |
policyAssignmentScope |
string |
Szabályzat-hozzárendelés hatóköre. |
policyAssignmentVersion |
string |
A szabályzat-hozzárendelés kiértékelt verziója. |
policyDefinitionAction |
string |
Szabályzatdefiníciós művelet, azaz effektus. |
policyDefinitionCategory |
string |
Szabályzatdefiníciós kategória. |
policyDefinitionGroupNames |
string[] |
Szabályzatdefiníciós csoportnevek. |
policyDefinitionId |
string |
Szabályzatdefiníció azonosítója. |
policyDefinitionName |
string |
Szabályzatdefiníció neve. |
policyDefinitionReferenceId |
string |
A szabályzatkészleten belüli szabályzatdefiníció referencia-azonosítója, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policyDefinitionVersion |
string |
A szabályzatdefiníció kiértékelt verziója. |
policyEvaluationDetails |
Szabályzatértékelés részletei. |
|
policySetDefinitionCategory |
string |
Szabályzatkészlet-definíciókategória, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policySetDefinitionId |
string |
Szabályzatkészlet definícióazonosítója, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policySetDefinitionName |
string |
Szabályzatkészlet definíciójának neve, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policySetDefinitionOwner |
string |
Szabályzatkészlet-definíció tulajdonosa, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policySetDefinitionParameters |
string |
Szabályzatkészlet-definíciós paraméterek, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik. |
policySetDefinitionVersion |
string |
A szabályzatkészlet definíciójának kiértékelt verziója. |
resourceGroup |
string |
Az erőforráscsoport neve. |
resourceId |
string |
Erőforrás-azonosító. |
resourceLocation |
string |
Erőforrás helye. |
resourceTags |
string |
Erőforráscímkék listája. |
resourceType |
string |
Erőforrástípus. |
subscriptionId |
string |
Előfizetés azonosítója. |
timestamp |
string |
A szabályzatállapot rekordjának időbélyege. |
PolicyStatesQueryResults
Lekérdezési eredmények.
Name | Típus | Description |
---|---|---|
@odata.context |
string |
OData környezeti sztring; az OData-ügyfelek használják a típusadatok metaadatokon alapuló feloldására. |
@odata.count |
integer |
OData-entitások száma; A visszaadott szabályzatállapotrekordok számát jelöli. |
@odata.nextLink |
string |
Odata következő hivatkozása; URL-cím a következő eredménykészlet lekéréséhez. |
value |
Lekérdezési eredmények. |
PolicyStatesResource
A PolicyStates erőforrástípus alatti virtuális erőforrás. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok), míg az "alapértelmezett" az összes szabályzatállapotot jelöli.
Name | Típus | Description |
---|---|---|
default |
string |
|
latest |
string |
QueryFailure
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
Hibadefiníció. |