Skip to content

Commit 5bb77f1

Browse files
NarineMPhoenix He
authored and
00Kai0
committed
Dataplane policy states and events API swagger (Azure#8562)
* swagger documentation for data plane PolicyStates API * enable events api in 2019-10-01 api version * data plane events API and data plane states API fixes * Data plane sample fixes and resolving autorest tool compile errors Data plane sample fixes and resolving autorest tool compile errors * Added more examples for dp and minor fixes Added more examples for dp and minor fixes * Update api version in exisiting events API examples Update api version in exisiting events API examples to be 2019-10-01 * Fix model validator errors Fix model validator errors * Remove aggrigate data plane events and states examples from swagger Remove aggrigate data plane events and states examples from swagger * Revert - Add back references to aggrigated component counts Revert - Add back references to aggrigated component counts * Added additional properties bag to data plane json object Added additional properties bag to data plane json object * Added policyEvents for 2019-10-01 in readme * fixed sample ref file path * Addressed PR review feedback Addressed PR review feedback * Fix SDK automation error SDK automation is throwing an error if the parameter descriptions for $expand do not match across PolicyStates and PolicyEvents API. * Fix prettier Co-authored-by: Phoenix He <tih@microsoft.com>
1 parent acf0199 commit 5bb77f1

24 files changed

+2446
-2
lines changed

‎specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_FilterAndAggregateOnly.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parameters": {
3+
"policyEventsResource": "default",
4+
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
5+
"api-version": "2019-10-01",
6+
"$from": "2018-02-05T18:00:00Z",
7+
"$filter": "PolicyDefinitionAction eq 'deny'",
8+
"$apply": "aggregate($count as NumDenyEvents)"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
14+
"@odata.count": 1,
15+
"value": [
16+
{
17+
"@odata.id": null,
18+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
19+
"NumDenyEvents": 40
20+
}
21+
]
22+
}
23+
}
24+
}
25+
}

‎specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_FilterAndGroupByWithAggregate.json

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"parameters": {
3+
"policyEventsResource": "default",
4+
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
5+
"api-version": "2019-10-01",
6+
"$from": "2018-02-05T18:00:00Z",
7+
"$filter": "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'",
8+
"$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate($count as NumEvents))",
9+
"$top": 2
10+
},
11+
"responses": {
12+
"200": {
13+
"body": {
14+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
15+
"@odata.count": 2,
16+
"value": [
17+
{
18+
"@odata.id": null,
19+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
20+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29",
21+
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1",
22+
"policyDefinitionAction": "audit",
23+
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService",
24+
"NumEvents": 1
25+
},
26+
{
27+
"@odata.id": null,
28+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
29+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a",
30+
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/5948d091-78b7-4d3b-a404-cc6a0329b0c6",
31+
"policyDefinitionAction": "audit",
32+
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService",
33+
"NumEvents": 1
34+
}
35+
]
36+
}
37+
}
38+
}
39+
}

‎specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"parameters": {
3+
"policyEventsResource": "default",
4+
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
5+
"api-version": "2019-10-01",
6+
"$from": "2018-01-05T18:00:00Z",
7+
"$filter": "PolicyDefinitionAction ne 'audit' and PolicyDefinitionAction ne 'append'",
8+
"$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId))",
9+
"$top": 2
10+
},
11+
"responses": {
12+
"200": {
13+
"body": {
14+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
15+
"@odata.count": 2,
16+
"value": [
17+
{
18+
"@odata.id": null,
19+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
20+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku",
21+
"policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
22+
"policyDefinitionAction": "deny",
23+
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.storage/storageaccounts/7d528d3a"
24+
},
25+
{
26+
"@odata.id": null,
27+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
28+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa",
29+
"policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
30+
"policyDefinitionAction": "deny",
31+
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/mysa1"
32+
}
33+
]
34+
}
35+
}
36+
}
37+
}

‎specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_FilterAndMultipleGroups.json

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"parameters": {
3+
"policyEventsResource": "default",
4+
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
5+
"api-version": "2019-10-01",
6+
"$from": "2018-01-01T00:00:00Z",
7+
"$filter": "PolicyDefinitionAction eq 'deny'",
8+
"$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicyDefinitionId), aggregate($count as NumDeniedResources))",
9+
"$orderby": "NumDeniedResources desc",
10+
"$top": 10
11+
},
12+
"responses": {
13+
"200": {
14+
"body": {
15+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
16+
"@odata.count": 6,
17+
"value": [
18+
{
19+
"@odata.id": null,
20+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
21+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/0591f497c35344fcbaf7a393",
22+
"policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/e56962a6-4747-49cd-b67b-bf8b01975c4c",
23+
"NumDeniedResources": 3
24+
},
25+
{
26+
"@odata.id": null,
27+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
28+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1",
29+
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition1",
30+
"NumDeniedResources": 2
31+
},
32+
{
33+
"@odata.id": null,
34+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
35+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1",
36+
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition2",
37+
"NumDeniedResources": 2
38+
},
39+
{
40+
"@odata.id": null,
41+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
42+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku",
43+
"policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
44+
"NumDeniedResources": 1
45+
},
46+
{
47+
"@odata.id": null,
48+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
49+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa",
50+
"policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
51+
"NumDeniedResources": 1
52+
},
53+
{
54+
"@odata.id": null,
55+
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
56+
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/myassignment2",
57+
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition3",
58+
"NumDeniedResources": 1
59+
}
60+
]
61+
}
62+
}
63+
}
64+
}

‎specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_GetMetadata.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"parameters": {
3+
"scope": "subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
4+
"api-version": "2019-10-01"
5+
},
6+
"responses": {
7+
"200": {
8+
"headers": {
9+
"content-type": "application/xml"
10+
},
11+
"body": "<edmx:Edmx Version=\"4.0\" xmlns:edmx=\"http://docs.oasis-open.org/odata/ns/edmx\"> <edmx:DataServices> <Schema Namespace=\"Microsoft.WindowsAzure.Governance.Policy.Provider\" xmlns=\"http://docs.oasis-open.org/odata/ns/edm\"> <EntityType Name=\"PolicyEvent\"> <Key> <PropertyRef Name=\"Timestamp\" /> <PropertyRef Name=\"ResourceId\" /> <PropertyRef Name=\"PolicyAssignmentId\" /> <PropertyRef Name=\"PolicyDefinitionId\" /> </Key> <Property Name=\"Timestamp\" Type=\"Edm.DateTimeOffset\" /> <Property Name=\"ResourceId\" Type=\"Edm.String\" /> <Property Name=\"PolicyAssignmentId\" Type=\"Edm.String\" /> <Property Name=\"PolicyDefinitionId\" Type=\"Edm.String\" /> <Property Name=\"EffectiveParameters\" Type=\"Edm.String\" /> <Property Name=\"IsCompliant\" Type=\"Edm.Boolean\" /> <Property Name=\"SubscriptionId\" Type=\"Edm.String\" /> <Property Name=\"ResourceType\" Type=\"Edm.String\" /> <Property Name=\"ResourceLocation\" Type=\"Edm.String\" /> <Property Name=\"ResourceGroup\" Type=\"Edm.String\" /> <Property Name=\"ResourceTags\" Type=\"Edm.String\" /> <Property Name=\"PolicyAssignmentName\" Type=\"Edm.String\" /> <Property Name=\"PolicyAssignmentOwner\" Type=\"Edm.String\" /> <Property Name=\"PolicyAssignmentParameters\" Type=\"Edm.String\" /> <Property Name=\"PolicyAssignmentScope\" Type=\"Edm.String\" /> <Property Name=\"PolicyDefinitionName\" Type=\"Edm.String\" /> <Property Name=\"PolicyDefinitionAction\" Type=\"Edm.String\" /> <Property Name=\"PolicyDefinitionCategory\" Type=\"Edm.String\" /> <Property Name=\"PolicySetDefinitionId\" Type=\"Edm.String\" /> <Property Name=\"PolicySetDefinitionName\" Type=\"Edm.String\" /> <Property Name=\"PolicySetDefinitionOwner\" Type=\"Edm.String\" /> <Property Name=\"PolicySetDefinitionCategory\" Type=\"Edm.String\" /> <Property Name=\"PolicySetDefinitionParameters\" Type=\"Edm.String\" /> <Property Name=\"ManagementGroupIds\" Type=\"Edm.String\" /> <Property Name=\"PolicyDefinitionReferenceId\" Type=\"Edm.String\" /> <Property Name=\"TenantId\" Type=\"Edm.String\" /> <Property Name=\"PrincipalOid\" Type=\"Edm.String\" /> </EntityType> <Action Name=\"queryResults\" IsBound=\"true\" EntitySetPath=\"default\"> <Parameter Name=\"default\" Type=\"Collection(Microsoft.WindowsAzure.Governance.Policy.Provider.PolicyEvent)\" Nullable=\"false\" /> <ReturnType Type=\"Collection(Microsoft.WindowsAzure.Governance.Policy.Provider.PolicyEvent)\" Nullable=\"false\" /> </Action> <EntityContainer Name=\"DefaultContainer\"> <EntitySet Name=\"default\" EntityType=\"Microsoft.WindowsAzure.Governance.Policy.Provider.PolicyEvent\"> <Annotation Term=\"Org.OData.Core.V1.ResourcePath\" String=\"default\" /> <Annotation Term=\"Org.OData.Capabilities.V1.SearchRestrictions\"> <Record> <PropertyValue Property=\"Searchable\" Bool=\"false\" /> </Record> </Annotation> <Annotation Term=\"Org.OData.Capabilities.V1.InsertRestrictions\"> <Record> <PropertyValue Property=\"Insertable\" Bool=\"false\" /> </Record> </Annotation> <Annotation Term=\"Org.OData.Capabilities.V1.UpdateRestrictions\"> <Record> <PropertyValue Property=\"Updatable\" Bool=\"false\" /> </Record> </Annotation> <Annotation Term=\"Org.OData.Capabilities.V1.DeleteRestrictions\"> <Record> <PropertyValue Property=\"Deletable\" Bool=\"false\" /> </Record> </Annotation> </EntitySet> <Annotation Term=\"Org.OData.Core.V1.Description\" String=\"Policy Events\" /> </EntityContainer> <Annotations Target=\"Microsoft.WindowsAzure.Governance.Policy.Provider.DefaultContainer\"> <Annotation Term=\"Org.OData.Capabilities.V1.ConformanceLevel\"> <EnumMember>Org.OData.Capabilities.V1.ConformanceLevelType/Minimal</EnumMember> </Annotation> <Annotation Term=\"Org.OData.Capabilities.V1.SupportedFormats\"> <Collection> <String>application/json;odata.metadata=minimal;IEEE754Compatible=false;odata.streaming=true</String> <String>application/json;odata.metadata=none;IEEE754Compatible=false;odata.streaming=true</String> </Collection> </Annotation> <Annotation Term=\"Org.OData.Capabilities.V1.AsynchronousRequestsSupported\" Bool=\"true\" /> </Annotations> </Schema> </edmx:DataServices></edmx:Edmx>"
12+
}
13+
}
14+
}

0 commit comments

Comments
 (0)