Policy Metadata - Get Resource

Dienst:

Policy

API-Version:

2019-10-01

Dient zum Abrufen der Ressourcen für Richtlinienmetadaten.

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}?api-version=2019-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceName	path	True	string	Der Name der Richtlinienmetadatenressource.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyMetadata	Richtlinienmetadatenressourcendefinition.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a single policy metadata resource

Beispielanforderung

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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

Beispiel für eine Antwort

Statuscode:

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"
}

Definitionen

Name	Beschreibung
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
PolicyMetadata	Richtlinienmetadatenressourcendefinition.
TypedErrorInfo	Szenariospezifische Fehlerdetails.

ErrorDefinition

Objekt

Fehlerdefinition.

Name	Typ	Beschreibung
additionalInfo	TypedErrorInfo[]	Weitere szenariospezifische Fehlerdetails.
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	ErrorDefinition[]	Interne Fehlerdetails.
message	string	Beschreibung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

PolicyMetadata

Objekt

Richtlinienmetadatenressourcendefinition.

Name	Typ	Beschreibung
id	string	Die ID der Richtlinienmetadaten.
name	string	Der Name der Richtlinienmetadaten.
properties.additionalContentUrl	string	URL zum Abrufen zusätzlicher Inhalte zu den Ressourcenmetadaten.
properties.category	string	Die Kategorie der Richtlinienmetadaten.
properties.description	string	Die Beschreibung der Richtlinienmetadaten.
properties.metadata	object	Zusätzliche Metadaten.
properties.metadataId	string	Der Richtlinienmetadatenbezeichner.
properties.owner	string	Der Besitzer der Richtlinienmetadaten.
properties.requirements	string	Die Anforderungen der Richtlinienmetadaten.
properties.title	string	Der Titel der Richtlinienmetadaten.
type	string	Der Typ der Richtlinienmetadaten.

TypedErrorInfo

Objekt

Szenariospezifische Fehlerdetails.

Name	Typ	Beschreibung
info		Die szenariospezifischen Fehlerdetails.
type	string	Der Typ der enthaltenen Fehlerdetails.