Obtenir la ressource de métadonnées de stratégie.
GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}?api-version=2019-10-01
Paramètres URI
| Nom |
Dans |
Obligatoire |
Type |
Description |
|
resourceName
|
path |
True
|
string
|
Nom de la ressource de métadonnées de stratégie.
|
|
api-version
|
query |
True
|
string
|
Version de l’API cliente.
|
Réponses
| Nom |
Type |
Description |
|
200 OK
|
PolicyMetadata
|
Définition de ressource de métadonnées de stratégie.
|
|
Other Status Codes
|
ErrorResponse
|
Réponse d’erreur décrivant la raison de l’échec de l’opération.
|
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nom |
Description |
|
user_impersonation
|
Emprunter l’identité de votre compte d’utilisateur
|
Exemples
Sample Request
GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2?api-version=2019-10-01
import com.azure.core.util.Context;
/** 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", 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
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
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
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
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
{
"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"
}
Définitions
ErrorDefinition
Définition de l’erreur.
| Nom |
Type |
Description |
|
additionalInfo
|
TypedErrorInfo[]
|
Détails d’erreur supplémentaires spécifiques au scénario.
|
|
code
|
string
|
Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
|
|
details
|
ErrorDefinition[]
|
Détails de l’erreur interne.
|
|
message
|
string
|
Description de l'erreur.
|
|
target
|
string
|
Cible de l’erreur.
|
ErrorResponse
Réponse d’erreur.
Définition de ressource de métadonnées de stratégie.
| Nom |
Type |
Description |
|
id
|
string
|
ID des métadonnées de stratégie.
|
|
name
|
string
|
Nom des métadonnées de stratégie.
|
|
properties.additionalContentUrl
|
string
|
URL pour obtenir du contenu supplémentaire sur les métadonnées de ressource.
|
|
properties.category
|
string
|
Catégorie des métadonnées de stratégie.
|
|
properties.description
|
string
|
Description des métadonnées de stratégie.
|
|
properties.metadata
|
object
|
Métadonnées supplémentaires.
|
|
properties.metadataId
|
string
|
Identificateur de métadonnées de stratégie.
|
|
properties.owner
|
string
|
Propriétaire des métadonnées de stratégie.
|
|
properties.requirements
|
string
|
Exigences des métadonnées de stratégie.
|
|
properties.title
|
string
|
Titre des métadonnées de stratégie.
|
|
type
|
string
|
Type des métadonnées de stratégie.
|
TypedErrorInfo
Détails de l’erreur spécifique au scénario.
| Nom |
Type |
Description |
|
info
|
|
Détails de l’erreur spécifique au scénario.
|
|
type
|
string
|
Type de détails d’erreur inclus.
|