Policy Restrictions - Check At Management Group Scope

Ссылка

Служба:: Policy

Версия API:: 2023-03-01

Проверяет, какие ограничения политики Azure будут размещаться на ресурсах в группе управления.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
managementGroupId	path	True	string	Идентификатор группы управления.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Тип	Описание
pendingFields	PendingField[]	Список полей и значений, которые следует оценить для потенциальных ограничений.
resourceDetails	CheckRestrictionsResourceDetails	Сведения о ресурсе, который будет оцениваться.

Ответы

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Check policy restrictions at management group scope

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

HTTP

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

{
  "pendingFields": [
    {
      "field": "type"
    }
  ]
}

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

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

{
  "fieldRestrictions": [
    {
      "field": "type",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Microsoft.Compute/virtualMachines"
          ],
          "policy": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyDefinitions/allowedTypes",
            "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "type not allowed"
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": []
  }
}

Определения

Имя	Описание
CheckManagementGroupRestrictionsRequest	Параметры политики проверки, описывающие вычисляемый ресурс.
CheckRestrictionEvaluationDetails	Сведения об оценке политики.
CheckRestrictionsResourceDetails	Сведения о ресурсе, который будет оцениваться.
CheckRestrictionsResult	Результат оценки ограничений политики проверки для ресурса.
ContentEvaluationResult	Результаты оценки для предоставленного содержимого частичного ресурса.
ErrorDefinition	Определение ошибки.
ErrorResponse	Ответ на ошибку.
ExpressionEvaluationDetails	Сведения об оценке выражений языка политики.
FieldRestriction	Ограничения на поле, введенное определенной политикой.
FieldRestrictionResult	Тип ограничений, введенных для поля.
FieldRestrictions	Ограничения, которые будут помещены в поле в ресурсе по политике.
IfNotExistsEvaluationDetails	Сведения об оценке эффекта IfNotExists.
ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
PendingField	Поле, которое должно оцениваться с помощью политики Azure для определения ограничений.
PolicyEffectDetails	Сведения о эффекте, примененного к ресурсу.
PolicyEvaluationResult	Результат оценки несоответствующей политики по заданному содержимому ресурса.
PolicyReference	Идентификаторы ресурсов для политики.
TypedErrorInfo	Сведения о конкретной ошибке сценария.

CheckManagementGroupRestrictionsRequest

Object

Параметры политики проверки, описывающие вычисляемый ресурс.

Имя	Тип	Описание
pendingFields	PendingField[]	Список полей и значений, которые следует оценить для потенциальных ограничений.
resourceDetails	CheckRestrictionsResourceDetails	Сведения о ресурсе, который будет оцениваться.

CheckRestrictionEvaluationDetails

Object

Сведения об оценке политики.

Имя	Тип	Описание
evaluatedExpressions	ExpressionEvaluationDetails[]	Сведения о вычисляемых выражениях.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Сведения об оценке эффекта IfNotExists.
reason	string	Причина результата оценки.

CheckRestrictionsResourceDetails

Object

Сведения о ресурсе, который будет оцениваться.

Имя	Тип	Описание
apiVersion	string	Версия API содержимого ресурса.
resourceContent	object	Содержимое ресурса. Это должно включать все уже известные свойства и может быть частичным набором всех свойств ресурсов.
scope	string	Область создания ресурса. Например, если ресурс является дочерним ресурсом, это будет идентификатор ресурса родительского ресурса.

CheckRestrictionsResult

Object

Результат оценки ограничений политики проверки для ресурса.

Имя	Тип	Описание
contentEvaluationResult	ContentEvaluationResult	Результаты оценки для предоставленного содержимого частичного ресурса.
fieldRestrictions	FieldRestrictions[]	Ограничения, которые будут помещены в различные поля в ресурсе по политике.

ContentEvaluationResult

Object

Результаты оценки для предоставленного содержимого частичного ресурса.

Имя	Тип	Описание
policyEvaluations	PolicyEvaluationResult[]	Результаты оценки политики по заданному содержимому ресурса. Это означает, что частичное содержимое, предоставленное, будет отказано в as-is.

ErrorDefinition

Object

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

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

ErrorResponse

Object

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

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

ExpressionEvaluationDetails

Object

Сведения об оценке выражений языка политики.

Имя	Тип	Описание
expression	string	Выражение вычисляется.
expressionKind	string	Тип вычисляемого выражения.
expressionValue	object	Значение выражения.
operator	string	Оператор для сравнения значения выражения и целевого значения.
path	string	Путь к свойству, если выражение является полем или псевдонимом.
result	string	Результат оценки.
targetValue	object	Целевое значение для сравнения со значением выражения.

FieldRestriction

Object

Ограничения на поле, введенное определенной политикой.

Имя	Тип	Описание
defaultValue	string	Значение, заданное политикой для поля, если пользователь не предоставляет значение.
policy	PolicyReference	Сведения о политике, вызывающей ограничение поля.
policyEffect	string	Эффект политики, вызывающей ограничение поля. http://aka.ms/policyeffects
reason	string	Причина ограничения.
result	FieldRestrictionResult	Тип ограничений, введенных для поля.
values	string[]	Значения, которые политика требует или запрещает для поля.

FieldRestrictionResult

Перечисление

Тип ограничений, введенных для поля.

Значение	Описание
Audit	Поля и (или) значения будут проверяться политикой.
Deny	Поле и(или) значения будут отклонены политикой.
Removed	Поле будет удалено политикой.
Required	Поля и/или значения требуются политикой.

FieldRestrictions

Object

Ограничения, которые будут помещены в поле в ресурсе по политике.

Имя	Тип	Описание
field	string	Имя поля. Это может быть свойство верхнего уровня, например "имя" или "тип" или псевдоним поля политики Azure.
restrictions	FieldRestriction[]	Ограничения, введенные в это поле по политике.

IfNotExistsEvaluationDetails

Object

Сведения об оценке эффекта IfNotExists.

Имя	Тип	Описание
resourceId	string	Идентификатор последнего вычисляемого ресурса для эффекта IfNotExists.
totalResources	integer	Общее количество ресурсов, к которым применимо условие существования.

ManagementGroupsNamespaceType

Перечисление

Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".

Значение	Описание
Microsoft.Management

PendingField

Object

Поле, которое должно оцениваться с помощью политики Azure для определения ограничений.

Имя	Тип	Описание
field	string	Имя поля. Это может быть свойство верхнего уровня, например "имя" или "тип" или псевдоним поля политики Azure.
values	string[]	Список потенциальных значений для поля, которое должно быть оценено по политике Azure.

PolicyEffectDetails

Object

Сведения о эффекте, примененного к ресурсу.

Имя	Тип	Описание
policyEffect	string	Эффект, примененный к ресурсу. http://aka.ms/policyeffects

PolicyEvaluationResult

Object

Результат оценки несоответствующей политики по заданному содержимому ресурса.

Имя	Тип	Описание
effectDetails	PolicyEffectDetails	Сведения о эффекте, примененного к ресурсу.
evaluationDetails	CheckRestrictionEvaluationDetails	Подробные результаты выражений и значений политики, которые были оценены.
evaluationResult	string	Результат оценки политики для ресурса. Обычно это будет значение "NonCompliant", но может содержать другие значения, если обнаружены ошибки.
policyInfo	PolicyReference	Сведения о политике, которую вычислили.

PolicyReference

Object

Идентификаторы ресурсов для политики.

Имя	Тип	Описание
policyAssignmentId	string	Идентификатор ресурса назначения политики.
policyDefinitionId	string	Идентификатор ресурса определения политики.
policyDefinitionReferenceId	string	Ссылочный идентификатор определенного определения политики в определении набора политик.
policySetDefinitionId	string	Идентификатор ресурса определения набора политик.

TypedErrorInfo

Object

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

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

Поделиться через

Policy Restrictions - Check At Management Group Scope

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

Check policy restrictions at management group scope

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

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

Определения

CheckManagementGroupRestrictionsRequest

CheckRestrictionEvaluationDetails

CheckRestrictionsResourceDetails

CheckRestrictionsResult

ContentEvaluationResult

ErrorDefinition

ErrorResponse

ExpressionEvaluationDetails

FieldRestriction

FieldRestrictionResult

FieldRestrictions

IfNotExistsEvaluationDetails

ManagementGroupsNamespaceType

PendingField

PolicyEffectDetails

PolicyEvaluationResult

PolicyReference

TypedErrorInfo

Дополнительные ресурсы