Policy Definitions - Get

Layanan:: Policy

Versi API:: 2023-04-01

Mengambil definisi kebijakan dalam langganan.
Operasi ini mengambil definisi kebijakan dalam langganan yang diberikan dengan nama yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
policyDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Nama definisi kebijakan yang akan didapatkan.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

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

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Retrieve a policy definition

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "properties": {
    "mode": "All",
    "displayName": "Naming Convention",
    "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "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"
      }
    },
    "parameters": {
      "prefix": {
        "type": "String",
        "metadata": {
          "displayName": "Prefix",
          "description": "Resource name prefix"
        }
      },
      "suffix": {
        "type": "String",
        "metadata": {
          "displayName": "Suffix",
          "description": "Resource name suffix"
        }
      }
    },
    "policyType": "Custom"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "ResourceNaming"
}

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	Jenis data parameter.
PolicyDefinition	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

Objek

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

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

ErrorResponse

Objek

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

Objek

Metadata umum untuk parameter .

Nama	Jenis	Deskripsi
assignPermissions	boolean	Atur ke true agar portal Microsoft 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 sadar konteks untuk dipilih pengguna.

ParameterDefinitionsValue

Objek

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 Json.NET Skema 2019-09. Anda dapat mempelajari selengkapnya tentang menggunakan skema di https://json-schema.org/ dan menguji skema draf di https://www.jsonschemavalidator.net/.
type	parameterType	Jenis data parameter.

parameterType

Enumerasi

Jenis data parameter.

Nilai	Deskripsi
String
Array
Object
Boolean
Integer
Float
DateTime