Add policy set definition APIs #1587
Add examples for policySetDefinition APIs
- Loading branch information
commit 59a4fcc24f6924593e8c07a3cba82ad41809a17c
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "subid", | ||
| "policySetDefinitionName": "costManagement", | ||
| "api-version": "2017-06-01-preview", | ||
| "parameters": { | ||
| "properties": { | ||
| "displayName": "VM and Storage Cost Management", | ||
| "description": "Policies required to minimize the risk of accidental cost overruns", | ||
| "metadata": { | ||
| "category": "Cost Management" | ||
| }, | ||
|
Contributor
There was a problem hiding this comment. example should include parameters since they are typically the most complex part of these objects |
||
| "policyDefinitions": [ | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/policyDefinitions/vmSkus" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "headers": {}, | ||
| "body": { | ||
| "id": "/subscriptions/subid/providers/Microsoft.Authorization/policySetDefinitions/costManagement", | ||
| "type": "Microsoft.Authorization/policySetDefinitions", | ||
| "name": "costManagement", | ||
| "properties": { | ||
| "displayName": "VM and Storage Cost Management", | ||
| "description": "Policies required to minimize the risk of accidental cost overruns", | ||
| "metadata": { | ||
| "category": "Cost Management" | ||
| }, | ||
| "policyDefinitions": [ | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subid/providers/Microsoft.Authorization/policyDefinitions/vmSkus" | ||
| } | ||
| ], | ||
| "policyType": "Custom" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "subid", | ||
| "policySetDefinitionName": "costManagement", | ||
| "api-version": "2017-06-01-preview" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "headers": {}, | ||
| "body": { | ||
| "id": "/subscriptions/subid/providers/Microsoft.Authorization/policySetDefinitions/costManagement", | ||
| "type": "Microsoft.Authorization/policySetDefinitions", | ||
| "name": "costManagement", | ||
| "properties": { | ||
| "displayName": "VM and Storage Cost Management", | ||
| "description": "Policies required to minimize the risk of accidental cost overruns", | ||
| "metadata": { | ||
| "category": "Cost Management" | ||
| }, | ||
| "parameters": { | ||
| "allowedLocations": { | ||
| "type": "array", | ||
| "metadata": { | ||
| "description": "Regions that resources can be deployed to", | ||
| "displayName": "Valid Regions" | ||
| } | ||
| } | ||
| }, | ||
| "policyDefinitions": [ | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subid/providers/Microsoft.Authorization/policyDefinitions/storageSkus", | ||
| "parameters": { | ||
| "listOfAllowedSKUs": { | ||
| "value": [ | ||
| "�Standard_GRS�", | ||
|
||
| "�Standard_LRS�" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subid/providers/Microsoft.Authorization/policyDefinitions/vmSkus" | ||
| }, | ||
| { | ||
| "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/policyDefinitionId", | ||
| "parameters": { | ||
| "listOfAllowedLocations": { | ||
| "value": "[parameters('allowedLocations')]" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "policyType": "Custom" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "subid", | ||
| "api-version": "2017-06-01-preview" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "headers": {}, | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "id": "/subscriptions/subid/providers/Microsoft.Authorization/policySetDefinitions/costManagement", | ||
| "type": "Microsoft.Authorization/policySetDefinitions", | ||
| "name": "costManagement", | ||
| "properties": { | ||
| "displayName": "VM and Storage Cost Management", | ||
| "description": "Policies required to minimize the risk of accidental cost overruns", | ||
| "metadata": { | ||
| "category": "Cost Management" | ||
| }, | ||
| "parameters": { | ||
| "allowedLocations": { | ||
|
Contributor
There was a problem hiding this comment. both policySets returned in this example are actually invalid. They have a parameter defined that is never used in a policyDefinition reference
Contributor
Author
There was a problem hiding this comment. Can you please elaborate? This is listing the policy sets, where is policyDefinition reference defined here?
Contributor
There was a problem hiding this comment. The sets in this example have an "allowedLocations" parameter. In order for this to be a valid set definition that "allowedLocations" parameter needs to be referenced by one of the parameters in the "policyDefinitions" array. Similar to what getPolicySetDefinition example has: {
|
||
| "type": "array", | ||
| "metadata": { | ||
| "description": "Regions that resources can be deployed to", | ||
| "displayName": "Valid Regions" | ||
| } | ||
| } | ||
| }, | ||
| "policyDefinitions": [ | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subid/providers/Microsoft.Authorization/policyDefinitions/storageSkus", | ||
| "parameters": { | ||
| "listOfAllowedSKUs": { | ||
| "value": [ | ||
|
||
| "�Standard_GRS�", | ||
|
||
| "�Standard_LRS�" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "policyType": "Custom" | ||
| } | ||
| }, | ||
| { | ||
| "id": "/subscriptions/subid/providers/Microsoft.Authorization/policySetDefinitions/skuManagement", | ||
| "type": "Microsoft.Authorization/policySetDefinitions", | ||
| "name": "skuManagement", | ||
| "properties": { | ||
| "displayName": "VM Sku Management", | ||
| "description": "Policies required to minimize the risk of accidental cost overruns", | ||
| "metadata": { | ||
| "category": "Sku Management" | ||
| }, | ||
| "parameters": { | ||
| "allowedLocations": { | ||
| "type": "array", | ||
| "metadata": { | ||
| "description": "Regions that resources can be deployed to", | ||
| "displayName": "Valid Regions" | ||
| } | ||
| } | ||
| }, | ||
| "policyDefinitions": [ | ||
| { | ||
| "policyDefinitionId": "/subscriptions/subid/providers/Microsoft.Authorization/policyDefinitions/vmSkus" | ||
| } | ||
| ], | ||
| "policyType": "Custom" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these example files need to be referenced in the swagger spec for them to show up in documentation, right? See https://github.com/pilor/azure-rest-api-specs/blob/current/documentation/x-ms-examples.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course they should! thanks for catching this