Policy Restrictions - Check At Subscription Scope

Sprawdza, jakie ograniczenia Azure Policy będą stosowane do zasobu w ramach subskrypcji.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2020-07-01

Parametry identyfikatora URI

Name In Required Type Description
subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia na potrzeby tej operacji.

Treść żądania

Name Required Type Description
resourceDetails True

Informacje o zasobie, który zostanie oceniony.

pendingFields

Lista pól i wartości, które powinny być oceniane pod kątem potencjalnych ograniczeń.

Odpowiedzi

Name Type Description
200 OK

Ograniczenia, które zostaną nałożone na zasób przez Azure Policy.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

Check policy restrictions at subscription scope

Sample Request

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2020-07-01

{
  "resourceDetails": {
    "resourceContent": {
      "type": "Microsoft.Compute/virtualMachines",
      "properties": {
        "priority": "Spot"
      }
    },
    "apiVersion": "2019-12-01"
  },
  "pendingFields": [
    {
      "field": "name",
      "values": [
        "myVMName"
      ]
    },
    {
      "field": "location",
      "values": [
        "eastus",
        "westus",
        "westus2",
        "westeurope"
      ]
    },
    {
      "field": "tags"
    }
  ]
}

Sample Response

{
  "fieldRestrictions": [
    {
      "field": "tags.newtag",
      "restrictions": [
        {
          "result": "Required",
          "defaultValue": "defaultVal",
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    },
    {
      "field": "tags.environment",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Prod",
            "Int",
            "Test"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    },
    {
      "field": "location",
      "restrictions": [
        {
          "result": "Deny",
          "values": [
            "west europe"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A",
            "policyDefinitionReferenceId": "DefRef"
          }
        },
        {
          "result": "Deny",
          "values": [
            "eastus",
            "westus"
          ],
          "policy": {
            "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B",
            "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D",
            "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B",
            "policyDefinitionReferenceId": "DefRef"
          }
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": [
      {
        "policyInfo": {
          "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41",
          "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E",
          "policyDefinitionReferenceId": "defref222",
          "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37"
        },
        "evaluationResult": "NonCompliant",
        "evaluationDetails": {
          "evaluatedExpressions": [
            {
              "result": "True",
              "expressionKind": "field",
              "expression": "type",
              "path": "type",
              "expressionValue": "microsoft.compute/virtualmachines",
              "targetValue": "microsoft.compute/virtualmachines",
              "operator": "equals"
            }
          ]
        }
      }
    ]
  }
}

Definicje

CheckRestrictionsRequest

Sprawdź parametry ograniczeń zasad opisujące szacowany zasób.

CheckRestrictionsResourceDetails

Informacje o zasobie, który zostanie oceniony.

CheckRestrictionsResult

Wynik oceny ograniczeń zasad sprawdzania zasobu.

ContentEvaluationResult

Wyniki oceny dla podanej częściowej zawartości zasobów.

ErrorDefinition

Definicja błędu.

ErrorResponse

Odpowiedź na błąd.

ExpressionEvaluationDetails

Szczegóły oceny wyrażeń języka zasad.

FieldRestriction

Ograniczenia dotyczące pola nałożonego przez określone zasady.

FieldRestrictionResult

Typ ograniczenia nałożonego na pole.

FieldRestrictions

Ograniczenia, które zostaną umieszczone w polu w zasobie według zasad.

IfNotExistsEvaluationDetails

Szczegóły oceny efektu IfNotExists.

PendingField

Pole, które powinno zostać ocenione pod kątem Azure Policy w celu określenia ograniczeń.

PolicyEvaluationDetails

Szczegóły oceny zasad.

PolicyEvaluationResult

Wynik oceny zasad niezgodnych z daną zawartością zasobu.

PolicyReference

Identyfikatory zasobów dla zasad.

TypedErrorInfo

Szczegóły błędu specyficzne dla scenariusza.

CheckRestrictionsRequest

Sprawdź parametry ograniczeń zasad opisujące szacowany zasób.

Name Type Description
pendingFields

Lista pól i wartości, które powinny być oceniane pod kątem potencjalnych ograniczeń.

resourceDetails

Informacje o zasobie, który zostanie oceniony.

CheckRestrictionsResourceDetails

Informacje o zasobie, który zostanie oceniony.

Name Type Description
apiVersion
  • string

Wersja interfejsu API zawartości zasobu.

resourceContent
  • object

Zawartość zasobu. Powinno to obejmować wszystkie znane właściwości i może być częściowym zestawem wszystkich właściwości zasobów.

scope
  • string

Zakres, w którym jest tworzony zasób. Jeśli na przykład zasób jest zasobem podrzędnym, będzie to identyfikator zasobu nadrzędnego.

CheckRestrictionsResult

Wynik oceny ograniczeń zasad sprawdzania zasobu.

Name Type Description
contentEvaluationResult

Wyniki oceny dla podanej częściowej zawartości zasobów.

fieldRestrictions

Ograniczenia, które zostaną umieszczone w różnych polach w zasobie według zasad.

ContentEvaluationResult

Wyniki oceny dla podanej częściowej zawartości zasobów.

Name Type Description
policyEvaluations

Wyniki oceny zasad względem danej zawartości zasobu. Spowoduje to wskazanie, czy podana zawartość częściowa zostanie odrzucona zgodnie z rzeczywistym stanem.

ErrorDefinition

Definicja błędu.

Name Type Description
additionalInfo

Dodatkowe szczegóły błędu specyficzne dla scenariusza.

code
  • string

Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.

details

Szczegóły błędu wewnętrznego.

message
  • string

Opis błędu.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
error

Szczegóły błędu.

ExpressionEvaluationDetails

Szczegóły oceny wyrażeń języka zasad.

Name Type Description
expression
  • string

Obliczone wyrażenie.

expressionKind
  • string

Rodzaj wyrażenia, które zostało obliczone.

expressionValue
  • object

Wartość wyrażenia.

operator
  • string

Operator do porównywania wartości wyrażenia i wartości docelowej.

path
  • string

Ścieżka właściwości, jeśli wyrażenie jest polem lub aliasem.

result
  • string

Wynik oceny.

targetValue
  • object

Wartość docelowa do porównania z wartością wyrażenia.

FieldRestriction

Ograniczenia dotyczące pola nałożonego przez określone zasady.

Name Type Description
defaultValue
  • string

Wartość, która zostanie ustawiona dla pola, jeśli użytkownik nie podaje wartości.

policy

Szczegóły zasad, które powodują ograniczenie pola.

result

Typ ograniczenia nałożonego na pole.

values
  • string[]

Wartości, które są wymagane przez zasady, lub odrzucane dla pola.

FieldRestrictionResult

Typ ograniczenia nałożonego na pole.

Name Type Description
Deny
  • string

Pola i/lub wartości zostaną odrzucone przez zasady.

Removed
  • string

Pole zostanie usunięte przez zasady.

Required
  • string

Pola i/lub wartości są wymagane przez zasady.

FieldRestrictions

Ograniczenia, które zostaną umieszczone w polu w zasobie według zasad.

Name Type Description
field
  • string

Nazwa pola. Może to być właściwość najwyższego poziomu, taka jak "name" lub "type" lub alias pola Azure Policy.

restrictions

Ograniczenia wprowadzone w tym polu przez zasady.

IfNotExistsEvaluationDetails

Szczegóły oceny efektu IfNotExists.

Name Type Description
resourceId
  • string

Identyfikator ostatniego ocenianego zasobu dla efektu IfNotExists.

totalResources
  • integer

Łączna liczba zasobów, do których ma zastosowanie warunek istnienia.

PendingField

Pole, które powinno zostać ocenione pod kątem Azure Policy w celu określenia ograniczeń.

Name Type Description
field
  • string

Nazwa pola. Może to być właściwość najwyższego poziomu, taka jak "name" lub "type" lub alias pola Azure Policy.

values
  • string[]

Lista potencjalnych wartości pola, które powinny być oceniane względem Azure Policy.

PolicyEvaluationDetails

Szczegóły oceny zasad.

Name Type Description
evaluatedExpressions

Szczegóły obliczonych wyrażeń.

ifNotExistsDetails

Szczegóły oceny efektu IfNotExists.

PolicyEvaluationResult

Wynik oceny zasad niezgodnych z daną zawartością zasobu.

Name Type Description
evaluationDetails

Szczegółowe wyniki wyrażeń zasad i wartości, które zostały ocenione.

evaluationResult
  • string

Wynik oceny zasad względem zasobu. Zazwyczaj będzie to wartość "NonCompliant", ale może zawierać inne wartości, jeśli napotkano błędy.

policyInfo

Szczegóły zasad, które zostały ocenione.

PolicyReference

Identyfikatory zasobów dla zasad.

Name Type Description
policyAssignmentId
  • string

Identyfikator zasobu przypisania zasad.

policyDefinitionId
  • string

Identyfikator zasobu definicji zasad.

policyDefinitionReferenceId
  • string

Identyfikator odwołania określonej definicji zasad w definicji zestawu zasad.

policySetDefinitionId
  • string

Identyfikator zasobu definicji zestawu zasad.

TypedErrorInfo

Szczegóły błędu specyficzne dla scenariusza.

Name Type Description
info

Szczegóły błędu specyficzne dla scenariusza.

type
  • string

Typ dołączonych szczegółów błędu.