Policy Metadata - List

Obtenir la liste des ressources de métadonnées de la stratégie.

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

Paramètres URI

Name In Required Type Description
api-version
query True
  • string

Version de l’API cliente.

$top
query
  • integer
int32

Nombre maximal d’enregistrements à retourner.

Réponses

Name Type Description
200 OK

Collection de ressources de métadonnées de stratégie.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Get collection of policy metadata resources
Get collection of policy metadata resources using top query parameter

Get collection of policy metadata resources

Sample Request

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

Sample Response

{
  "value": [
    {
      "properties": {
        "metadataId": "NIST SP 800-53 R4 AC-2",
        "category": "Access control",
        "title": "Account Management",
        "owner": "Shared",
        "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"
    }
  ]
}

Get collection of policy metadata resources using top query parameter

Sample Request

GET https://management.azure.com/providers/Microsoft.PolicyInsights/policyMetadata?api-version=2019-10-01&$top=1

Sample Response

{
  "value": [
    {
      "properties": {
        "metadataId": "NIST SP 800-53 R4 AC-2",
        "category": "Access control",
        "title": "Account Management",
        "owner": "Shared",
        "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.

ErrorResponse

Réponse d’erreur.

PolicyMetadataCollection

Collection de ressources de métadonnées de stratégie.

SlimPolicyMetadata

Version allégée de la définition de ressource de métadonnées de stratégie, en excluant les propriétés avec des chaînes volumineuses

TypedErrorInfo

Détails de l’erreur spécifique au scénario.

ErrorDefinition

Définition de l’erreur.

Name Type Description
additionalInfo

Détails supplémentaires sur l’erreur spécifique au scénario.

code
  • string

Code d’erreur spécifique au service qui sert de sous-état du code d’erreur HTTP.

details

Détails de l’erreur interne.

message
  • string

Description de l'erreur.

target
  • string

Cible de l’erreur.

ErrorResponse

Réponse d’erreur.

Name Type Description
error

Détails de l’erreur.

PolicyMetadataCollection

Collection de ressources de métadonnées de stratégie.

Name Type Description
nextLink
  • string

URL permettant d’obtenir le jeu de résultats suivant.

value

Tableau de définitions de métadonnées de stratégie.

SlimPolicyMetadata

Version allégée de la définition de ressource de métadonnées de stratégie, en excluant les propriétés avec des chaînes volumineuses

Name Type Description
id
  • string

ID des métadonnées de la stratégie.

name
  • string

Nom des métadonnées de la stratégie.

properties.additionalContentUrl
  • string

URL pour obtenir du contenu supplémentaire sur les métadonnées de la ressource.

properties.category
  • string

Catégorie des métadonnées de la stratégie.

properties.metadata
  • object

Métadonnées supplémentaires.

properties.metadataId
  • string

Identificateur des métadonnées de la stratégie.

properties.owner
  • string

Propriétaire des métadonnées de la stratégie.

properties.title
  • string

Titre des métadonnées de la stratégie.

type
  • string

Type des métadonnées de la stratégie.

TypedErrorInfo

Détails de l’erreur spécifique au scénario.

Name Type Description
info

Détails de l’erreur spécifique au scénario.

type
  • string

Type des détails de l’erreur inclus.