Policy Definitions - List

Service:

Policy

API Version:

2023-04-01

Mengambil definisi kebijakan dalam langganan
Operasi ini mengambil daftar semua definisi kebijakan dalam langganan tertentu yang cocok dengan $filter yang diberikan opsional. Nilai yang valid untuk $filter adalah: 'atExactScope()', 'policyType -eq {value}' atau 'category eq '{value}''. Jika $filter tidak disediakan, daftar yang tidak difilter menyertakan semua definisi kebijakan yang terkait dengan langganan, termasuk yang berlaku secara langsung atau dari grup manajemen yang berisi langganan tertentu. Jika $filter=atExactScope() disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang pada langganan tertentu. Jika $filter='policyType -eq {value}' disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang tipenya cocok dengan {value}. Nilai policyType yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static. Jika $filter='category -eq {value}' disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang kategorinya cocok dengan {value}.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string uuid	ID langganan target. Nilai harus UUID.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
$filter	query		string	Filter yang akan diterapkan pada operasi. Nilai yang valid untuk $filter adalah: 'atExactScope()', 'policyType -eq {value}' atau 'category eq '{value}''. Jika $filter tidak disediakan, tidak ada pemfilteran yang dilakukan. Jika $filter=atExactScope() disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang pada cakupan yang diberikan. Jika $filter='policyType -eq {value}' disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang tipenya cocok dengan {value}. Nilai policyType yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static. Jika $filter='category -eq {value}' disediakan, daftar yang dikembalikan hanya menyertakan semua definisi kebijakan yang kategorinya cocok dengan {value}.
$top	query		integer int32	Jumlah maksimum rekaman yang akan dikembalikan. Ketika filter $top tidak disediakan, filter akan mengembalikan 500 rekaman.

Respons

Nama	Jenis	Deskripsi
200 OK	PolicyDefinitionListResult	OK - Mengembalikan array definisi kebijakan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List policy definitions by subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_policy_definitions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_definitions.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicyDefinitions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "mode": "All",
        "displayName": "Allowed storage account SKUs",
        "policyType": "BuiltIn",
        "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.",
        "parameters": {
          "listOfAllowedSKUs": {
            "type": "Array",
            "metadata": {
              "description": "The list of SKUs that can be specified for storage accounts.",
              "displayName": "Allowed SKUs",
              "strongType": "StorageSKUs"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "allOf": [
              {
                "field": "type",
                "equals": "Microsoft.Storage/storageAccounts"
              },
              {
                "not": {
                  "field": "Microsoft.Storage/storageAccounts/sku.name",
                  "in": "[parameters('listOfAllowedSKUs')]"
                }
              }
            ]
          },
          "then": {
            "effect": "Deny"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "ResourceNaming"
    },
    {
      "properties": {
        "mode": "Microsoft.KeyVault.Data",
        "displayName": "Audit KeyVault certificates that expire within specified number of days",
        "description": "Audit certificates that are stored in Azure Key Vault, that expire within 'X' number of days.",
        "metadata": {
          "category": "KeyVault DataPlane"
        },
        "parameters": {
          "daysToExpire": {
            "type": "Integer",
            "metadata": {
              "displayName": "Days to expire",
              "description": "The number of days for a certificate to expire."
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "field": "Microsoft.KeyVault.Data/vaults/certificates/attributes/expiresOn",
            "lessOrEquals": "[addDays(utcNow(), parameters('daysToExpire'))]"
          },
          "then": {
            "effect": "audit"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/AuditSoonToExpireCerts",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "AuditSoonToExpireCerts"
    }
  ]
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari operasi kebijakan.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons Kesalahan
Metadata	Metadata umum untuk parameter .
ParameterDefinitionsValue	Definisi parameter yang dapat diberikan ke kebijakan.
parameterType	Tipe data parameter.
PolicyDefinition	Definisi kebijakan.
PolicyDefinitionListResult	Daftar definisi kebijakan.
policyType	Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

Respons kesalahan dari operasi kebijakan.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Respons Kesalahan

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

Metadata

Metadata umum untuk parameter .

Nama	Jenis	Deskripsi
assignPermissions	boolean	Atur ke true agar portal Azure membuat penetapan peran pada ID sumber daya atau nilai cakupan sumber daya parameter ini selama penetapan kebijakan. Properti ini berguna jika Anda ingin menetapkan izin di luar cakupan penugasan.
description	string	Deskripsi parameter .
displayName	string	Nama tampilan untuk parameter .
strongType	string	Digunakan saat menetapkan definisi kebijakan melalui portal. Menyediakan daftar nilai konteks yang mengetahui untuk dipilih pengguna.

ParameterDefinitionsValue

Definisi parameter yang dapat diberikan ke kebijakan.

Nama	Jenis	Deskripsi
allowedValues	object[]	Nilai yang diizinkan untuk parameter .
defaultValue	object	Nilai default untuk parameter jika tidak ada nilai yang disediakan.
metadata	Metadata	Metadata umum untuk parameter .
schema	object	Menyediakan validasi input parameter selama penugasan menggunakan skema JSON yang ditentukan sendiri. Properti ini hanya didukung untuk parameter jenis objek dan mengikuti implementasi Skema Json.NET 2019-09. Anda dapat mempelajari selengkapnya penggunaan skema di https://json-schema.org/ dan menguji skema draf di https://www.jsonschemavalidator.net/.
type	parameterType	Tipe data parameter.

parameterType

Tipe data parameter.

Nama	Jenis	Deskripsi
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

PolicyDefinition

Definisi kebijakan.

Nama	Jenis	Nilai Default	Deskripsi
id	string		ID definisi kebijakan.
name	string		Nama definisi kebijakan.
properties.description	string		Deskripsi definisi kebijakan.
properties.displayName	string		Nama tampilan definisi kebijakan.
properties.metadata	object		Metadata definisi kebijakan. Metadata adalah objek terbuka dan biasanya merupakan kumpulan pasangan nilai kunci.
properties.mode	string	Indexed	Mode definisi kebijakan. Beberapa contohnya adalah Semua, Terindeks, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>		Definisi parameter untuk parameter yang digunakan dalam aturan kebijakan. Kuncinya adalah nama parameter.
properties.policyRule	object		Aturan kebijakan.
properties.policyType	policyType		Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static.
properties.version	string		Versi definisi kebijakan dalam format #.#.#. .
properties.versions	string[]		Daftar versi yang tersedia untuk definisi kebijakan ini.
systemData	systemData		Metadata sistem yang berkaitan dengan sumber daya ini.
type	string		Jenis sumber daya (Microsoft.Authorization/policyDefinitions).

PolicyDefinitionListResult

Daftar definisi kebijakan.

Nama	Jenis	Deskripsi
nextLink	string	URL yang digunakan untuk mendapatkan serangkaian hasil berikutnya.
value	PolicyDefinition[]	Array definisi kebijakan.

policyType

Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static.

Nama	Jenis	Deskripsi
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.