Policy Restrictions - Check At Subscription Scope

Memeriksa batasan apa yang akan Azure Policy lakukan pada sumber daya dalam langganan.

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

Parameter URI

Name In Required Type Description
subscriptionId
path True
  • string

ID langganan target.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Required Type Description
resourceDetails True

Informasi tentang sumber daya yang akan dievaluasi.

pendingFields

Daftar bidang dan nilai yang harus dievaluasi untuk potensi pembatasan.

Respons

Name Type Description
200 OK

Pembatasan yang akan ditempatkan pada sumber daya dengan Azure Policy.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

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 meniru akun pengguna Anda

Contoh

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

Definisi

CheckRestrictionsRequest

Parameter pembatasan kebijakan pemeriksaan yang menjelaskan sumber daya yang sedang dievaluasi.

CheckRestrictionsResourceDetails

Informasi tentang sumber daya yang akan dievaluasi.

CheckRestrictionsResult

Hasil dari evaluasi pembatasan kebijakan pemeriksaan pada sumber daya.

ContentEvaluationResult

Hasil evaluasi untuk konten sumber daya parsial yang disediakan.

ErrorDefinition

Definisi kesalahan.

ErrorResponse

Respons kesalahan.

ExpressionEvaluationDetails

Detail evaluasi ekspresi bahasa kebijakan.

FieldRestriction

Pembatasan pada bidang yang diberlakukan oleh kebijakan tertentu.

FieldRestrictionResult

Jenis pembatasan yang diberlakukan pada bidang .

FieldRestrictions

Pembatasan yang akan ditempatkan pada bidang dalam sumber daya berdasarkan kebijakan.

IfNotExistsEvaluationDetails

Detail evaluasi efek IfNotExists.

PendingField

Bidang yang harus dievaluasi terhadap Azure Policy untuk menentukan pembatasan.

PolicyEvaluationDetails

Detail evaluasi kebijakan.

PolicyEvaluationResult

Hasil evaluasi kebijakan yang tidak sesuai terhadap konten sumber daya yang diberikan.

PolicyReference

Pengidentifikasi sumber daya untuk kebijakan.

TypedErrorInfo

Detail kesalahan spesifik skenario.

CheckRestrictionsRequest

Parameter pembatasan kebijakan pemeriksaan yang menjelaskan sumber daya yang sedang dievaluasi.

Name Type Description
pendingFields

Daftar bidang dan nilai yang harus dievaluasi untuk potensi pembatasan.

resourceDetails

Informasi tentang sumber daya yang akan dievaluasi.

CheckRestrictionsResourceDetails

Informasi tentang sumber daya yang akan dievaluasi.

Name Type Description
apiVersion
  • string

Versi api dari konten sumber daya.

resourceContent
  • object

Konten sumber daya. Ini harus mencakup properti apa pun yang sudah diketahui dan dapat menjadi sekumpulan parsial dari semua properti sumber daya.

scope
  • string

Cakupan tempat sumber daya sedang dibuat. Misalnya, jika sumber daya adalah sumber daya anak, ini akan menjadi ID sumber daya sumber daya induk.

CheckRestrictionsResult

Hasil dari evaluasi pembatasan kebijakan pemeriksaan pada sumber daya.

Name Type Description
contentEvaluationResult

Hasil evaluasi untuk konten sumber daya parsial yang disediakan.

fieldRestrictions

Pembatasan yang akan ditempatkan pada berbagai bidang dalam sumber daya berdasarkan kebijakan.

ContentEvaluationResult

Hasil evaluasi untuk konten sumber daya parsial yang disediakan.

Name Type Description
policyEvaluations

Hasil evaluasi kebijakan terhadap konten sumber daya yang diberikan. Ini akan menunjukkan apakah konten parsial yang disediakan akan ditolak apa adanya.

ErrorDefinition

Definisi kesalahan.

Name Type Description
additionalInfo

Detail kesalahan spesifik skenario tambahan.

code
  • string

Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.

details

Detail kesalahan internal.

message
  • string

Deskripsi kesalahan.

target
  • string

Target kesalahan.

ErrorResponse

Respons kesalahan.

Name Type Description
error

Detail kesalahan.

ExpressionEvaluationDetails

Detail evaluasi ekspresi bahasa kebijakan.

Name Type Description
expression
  • string

Ekspresi dievaluasi.

expressionKind
  • string

Jenis ekspresi yang dievaluasi.

expressionValue
  • object

Nilai ekspresi.

operator
  • string

Operator untuk membandingkan nilai ekspresi dan nilai target.

path
  • string

Jalur properti jika ekspresi adalah bidang atau alias.

result
  • string

Hasil evaluasi.

targetValue
  • object

Nilai target yang akan dibandingkan dengan nilai ekspresi.

FieldRestriction

Pembatasan pada bidang yang diberlakukan oleh kebijakan tertentu.

Name Type Description
defaultValue
  • string

Nilai yang akan ditetapkan kebijakan untuk bidang jika pengguna tidak memberikan nilai.

policy

Detail kebijakan yang menyebabkan pembatasan bidang.

result

Jenis pembatasan yang diberlakukan pada bidang .

values
  • string[]

Nilai yang diperlukan kebijakan atau tolak untuk bidang .

FieldRestrictionResult

Jenis pembatasan yang diberlakukan pada bidang .

Name Type Description
Deny
  • string

Bidang dan/atau nilai akan ditolak oleh kebijakan.

Removed
  • string

Bidang akan dihapus oleh kebijakan.

Required
  • string

Bidang dan/atau nilai diperlukan oleh kebijakan.

FieldRestrictions

Pembatasan yang akan ditempatkan pada bidang dalam sumber daya berdasarkan kebijakan.

Name Type Description
field
  • string

Nama bidang. Ini bisa menjadi properti tingkat atas seperti 'nama' atau 'jenis' atau alias bidang Azure Policy.

restrictions

Pembatasan ditempatkan pada bidang tersebut berdasarkan kebijakan.

IfNotExistsEvaluationDetails

Detail evaluasi efek IfNotExists.

Name Type Description
resourceId
  • string

ID sumber daya terakhir yang dievaluasi untuk efek IfNotExists.

totalResources
  • integer

Jumlah total sumber daya yang kondisi keberadaannya berlaku.

PendingField

Bidang yang harus dievaluasi terhadap Azure Policy untuk menentukan pembatasan.

Name Type Description
field
  • string

Nama bidang. Ini bisa menjadi properti tingkat atas seperti 'nama' atau 'jenis' atau alias bidang Azure Policy.

values
  • string[]

Daftar nilai potensial untuk bidang yang harus dievaluasi terhadap Azure Policy.

PolicyEvaluationDetails

Detail evaluasi kebijakan.

Name Type Description
evaluatedExpressions

Detail ekspresi yang dievaluasi.

ifNotExistsDetails

Detail evaluasi efek IfNotExists.

PolicyEvaluationResult

Hasil evaluasi kebijakan yang tidak sesuai terhadap konten sumber daya yang diberikan.

Name Type Description
evaluationDetails

Hasil terperinci dari ekspresi dan nilai kebijakan yang dievaluasi.

evaluationResult
  • string

Hasil evaluasi kebijakan terhadap sumber daya. Ini biasanya akan menjadi 'Tidak Patuh' tetapi mungkin berisi nilai lain jika terjadi kesalahan.

policyInfo

Detail kebijakan yang dievaluasi.

PolicyReference

Pengidentifikasi sumber daya untuk kebijakan.

Name Type Description
policyAssignmentId
  • string

Pengidentifikasi sumber daya penetapan kebijakan.

policyDefinitionId
  • string

Pengidentifikasi sumber daya definisi kebijakan.

policyDefinitionReferenceId
  • string

Pengidentifikasi referensi definisi kebijakan tertentu dalam definisi yang ditetapkan kebijakan.

policySetDefinitionId
  • string

Pengidentifikasi sumber daya dari definisi set kebijakan.

TypedErrorInfo

Detail kesalahan spesifik skenario.

Name Type Description
info

Detail kesalahan spesifik skenario.

type
  • string

Jenis detail kesalahan yang disertakan.