Policy Metadata - List

Obtenga una lista de los recursos de metadatos de directiva.

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}

Parámetros de identificador URI

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

Versión de api de cliente.

$top
query
  • integer
int32

Número máximo de registros que se van a devolver.

Respuestas

Name Type Description
200 OK

Colección de recursos de metadatos de directiva.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

ErrorDefinition

Definición de error.

ErrorResponse

Respuesta de error.

PolicyMetadataCollection

Colección de recursos de metadatos de directiva.

SlimPolicyMetadata

Versión delgada de la definición de recursos de metadatos de directiva, excepto las propiedades con cadenas grandes

TypedErrorInfo

Detalles de error específicos del escenario.

ErrorDefinition

Definición de error.

Name Type Description
additionalInfo

Detalles adicionales del error específico del escenario.

code
  • string

Código de error específico del servicio que actúa como subestado para el código de error HTTP.

details

Detalles internos del error.

message
  • string

Descripción del error.

target
  • string

Destino del error.

ErrorResponse

Respuesta de error.

Name Type Description
error

Los detalles del error.

PolicyMetadataCollection

Colección de recursos de metadatos de directiva.

Name Type Description
nextLink
  • string

Dirección URL para obtener el siguiente conjunto de resultados.

value

Matriz de definiciones de metadatos de directiva.

SlimPolicyMetadata

Versión delgada de la definición de recursos de metadatos de directiva, excepto las propiedades con cadenas grandes

Name Type Description
id
  • string

Identificador de los metadatos de la directiva.

name
  • string

Nombre de los metadatos de la directiva.

properties.additionalContentUrl
  • string

Dirección URL para obtener contenido adicional sobre los metadatos del recurso.

properties.category
  • string

Categoría de los metadatos de la directiva.

properties.metadata
  • object

Metadatos adicionales.

properties.metadataId
  • string

Identificador de metadatos de directiva.

properties.owner
  • string

Propietario de los metadatos de la directiva.

properties.title
  • string

Título de los metadatos de la directiva.

type
  • string

Tipo de los metadatos de la directiva.

TypedErrorInfo

Detalles de error específicos del escenario.

Name Type Description
info

Detalles específicos del error del escenario.

type
  • string

Tipo de detalles de error incluidos.