Policy Metadata - List

Служба:: Policy

Версия API:: 2024-10-01

Получите список ресурсов метаданных политики.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Версия клиентского API.
$top	query		integer (int32) minimum: 0	Максимальное количество возвращаемых записей.

Ответы

Имя	Тип	Описание
200 OK	PolicyMetadataCollection	Коллекция ресурсов метаданных политики.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get collection of policy metadata resources

Get collection of policy metadata resources using top query parameter

Get collection of policy metadata resources

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
ErrorDefinition	Определение ошибки.
ErrorResponse	Ответ на ошибку.
PolicyMetadataCollection	Коллекция ресурсов метаданных политики.
SlimPolicyMetadata	Слимная версия определения ресурса метаданных политики, за исключением свойств с большими строками
TypedErrorInfo	Сведения о конкретной ошибке сценария.

ErrorDefinition

Объект

Определение ошибки.

Имя	Тип	Описание
additionalInfo	TypedErrorInfo[]	Дополнительные сведения об ошибке для конкретного сценария.
code	string	Код ошибки конкретной службы, который служит подстатусом для кода ошибки HTTP.
details	ErrorDefinition[]	Сведения о внутренней ошибке.
message	string	Описание ошибки.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
error	ErrorDefinition	Сведения об ошибке.

PolicyMetadataCollection

Объект

Коллекция ресурсов метаданных политики.

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора результатов.
value	SlimPolicyMetadata[]	Массив определений метаданных политики.

SlimPolicyMetadata

Объект

Слимная версия определения ресурса метаданных политики, за исключением свойств с большими строками

Имя	Тип	Описание
id	string	Идентификатор метаданных политики.
name	string	Имя метаданных политики.
properties.additionalContentUrl	string	URL-адрес для получения дополнительного содержимого о метаданных ресурса.
properties.category	string	Категория метаданных политики.
properties.metadata	object	Дополнительные метаданные.
properties.metadataId	string	Идентификатор метаданных политики.
properties.owner	string	Владелец метаданных политики.
properties.title	string	Заголовок метаданных политики.
type	string	Тип метаданных политики.

TypedErrorInfo

Объект

Сведения о конкретной ошибке сценария.

Имя	Тип	Описание
info		Сведения о конкретной ошибке сценария.
type	string	Тип включенных сведений об ошибке.