Policy Metadata - Get Resource
Get policy metadata resource.
GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}?api-version=2019-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the policy metadata resource. |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Policy metadata resource definition. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
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 | impersonate your user account |
Examples
Get a single policy metadata resource
Sample request
Sample response
{
"properties": {
"metadataId": "NIST SP 800-53 R4 AC-2",
"category": "Access control",
"title": "Account Management",
"owner": "Shared",
"description": "Description of NIST SP 800-53 R4 AC-2",
"requirements": "List the requirements for NIST SP 800-53 R4 AC-2",
"additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2",
"metadata": {}
},
"id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2",
"name": "NIST_SP_800-53_R4_AC-2",
"type": "Microsoft.PolicyInsights/policyMetadata"
}
Definitions
Name | Description |
---|---|
Error |
Error definition. |
Error |
Error response. |
Policy |
Policy metadata resource definition. |
Typed |
Scenario specific error details. |
ErrorDefinition
Error definition.
Name | Type | Description |
---|---|---|
additionalInfo |
Additional scenario specific error details. |
|
code |
string |
Service specific error code which serves as the substatus for the HTTP error code. |
details |
Internal error details. |
|
message |
string |
Description of the error. |
target |
string |
The target of the error. |
ErrorResponse
Error response.
Name | Type | Description |
---|---|---|
error |
The error details. |
PolicyMetadata
Policy metadata resource definition.
Name | Type | Description |
---|---|---|
id |
string |
The ID of the policy metadata. |
name |
string |
The name of the policy metadata. |
properties.additionalContentUrl |
string |
Url for getting additional content about the resource metadata. |
properties.category |
string |
The category of the policy metadata. |
properties.description |
string |
The description of the policy metadata. |
properties.metadata |
object |
Additional metadata. |
properties.metadataId |
string |
The policy metadata identifier. |
properties.owner |
string |
The owner of the policy metadata. |
properties.requirements |
string |
The requirements of the policy metadata. |
properties.title |
string |
The title of the policy metadata. |
type |
string |
The type of the policy metadata. |
TypedErrorInfo
Scenario specific error details.
Name | Type | Description |
---|---|---|
info |
|
The scenario specific error details. |
type |
string |
The type of included error details. |