Policy Metadata - Get Resource

Service:

Policy

API Version:

2019-10-01

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
resourceName	path	True	string	The name of the policy metadata resource.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	PolicyMetadata	Policy metadata resource definition.
Other Status Codes	ErrorResponse	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

HTTP

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2?api-version=2019-10-01

Java

/**
 * Samples for PolicyMetadata GetResource.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/
     * PolicyMetadata_GetResource.json
     */
    /**
     * Sample code: Get a single policy metadata resource.
     * 
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void
        getASinglePolicyMetadataResource(com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.policyMetadatas().getResourceWithResponse("NIST_SP_800-53_R4_AC-2", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python policy_metadata_get_resource.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_metadata.get_resource(
        resource_name="NIST_SP_800-53_R4_AC-2",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyMetadata_GetResource.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpolicyinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/policyinsights/armpolicyinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05a9cdab363b8ec824094ee73950c04594325172/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyMetadata_GetResource.json
func ExamplePolicyMetadataClient_GetResource() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicyinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicyMetadataClient().GetResource(ctx, "NIST_SP_800-53_R4_AC-2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PolicyMetadata = armpolicyinsights.PolicyMetadata{
	// 	Name: to.Ptr("NIST_SP_800-53_R4_AC-2"),
	// 	Type: to.Ptr("Microsoft.PolicyInsights/policyMetadata"),
	// 	ID: to.Ptr("/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2"),
	// 	Properties: &armpolicyinsights.PolicyMetadataProperties{
	// 		AdditionalContentURL: to.Ptr("https://aka.ms/NIST_SP_800-53_R4_AC-2"),
	// 		Category: to.Ptr("Access control"),
	// 		Metadata: map[string]any{
	// 		},
	// 		MetadataID: to.Ptr("NIST SP 800-53 R4 AC-2"),
	// 		Owner: to.Ptr("Shared"),
	// 		Title: to.Ptr("Account Management"),
	// 		Description: to.Ptr("Description of NIST SP 800-53 R4 AC-2"),
	// 		Requirements: to.Ptr("List the requirements for NIST SP 800-53 R4 AC-2"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get policy metadata resource.
 *
 * @summary Get policy metadata resource.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyMetadata_GetResource.json
 */
async function getASinglePolicyMetadataResource() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceName = "NIST_SP_800-53_R4_AC-2";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.policyMetadataOperations.getResource(resourceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.PolicyInsights;

// Generated from example definition: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyMetadata_GetResource.json
// this example is just showing the usage of "PolicyMetadata_GetResource" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this PolicyMetadataResource created on azure
// for more information of creating PolicyMetadataResource, please refer to the document of PolicyMetadataResource
string resourceName = "NIST_SP_800-53_R4_AC-2";
ResourceIdentifier policyMetadataResourceId = PolicyMetadataResource.CreateResourceIdentifier(resourceName);
PolicyMetadataResource policyMetadata = client.GetPolicyMetadataResource(policyMetadataResourceId);

// invoke the operation
PolicyMetadataResource result = await policyMetadata.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PolicyMetadataData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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
ErrorDefinition	Error definition.
ErrorResponse	Error response.
PolicyMetadata	Policy metadata resource definition.
TypedErrorInfo	Scenario specific error details.

ErrorDefinition

Object

Error definition.

Name	Type	Description
additionalInfo	TypedErrorInfo[]	Additional scenario specific error details.
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.
target	string	The target of the error.

ErrorResponse

Object

Error response.

Name	Type	Description
error	ErrorDefinition	The error details.

PolicyMetadata

Object

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

Object

Scenario specific error details.

Name	Type	Description
info		The scenario specific error details.
type	string	The type of included error details.