Policy Definitions - Get
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 |
---|---|---|---|---|
policy
|
path | True |
string |
Nama definisi kebijakan yang akan didapatkan. Regex pattern: |
subscription
|
path | True |
string uuid |
ID langganan target. Nilainya harus UUID. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK - Mengembalikan informasi tentang definisi kebijakan. |
|
Other Status Codes |
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
Retrieve a policy definition
Sample Request
Sample Response
{
"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 |
---|---|
Cloud |
Respons kesalahan dari operasi kebijakan. |
created |
Jenis identitas yang membuat sumber daya. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Respons Kesalahan |
Metadata |
Metadata umum untuk parameter . |
Parameter |
Definisi parameter yang dapat diberikan ke kebijakan. |
parameter |
Tipe data parameter. |
Policy |
Definisi kebijakan. |
policy |
Jenis definisi kebijakan. Nilai yang mungkin adalah NotSpecified, BuiltIn, Custom, dan Static. |
system |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
CloudError
Respons kesalahan dari operasi kebijakan.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Respons Kesalahan |
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
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 diketahui 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 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 |
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,
Parameter |
Definisi parameter untuk parameter yang digunakan dalam aturan kebijakan. Kuncinya adalah nama parameter. |
|
properties.policyRule |
object |
Aturan kebijakan. |
|
properties.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 |
Metadata sistem yang berkaitan dengan sumber daya ini. |
||
type |
string |
Jenis sumber daya (Microsoft.Authorization/policyDefinitions). |
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 |
Jenis identitas yang membuat sumber daya. |
|
lastModifiedAt |
string |
Tanda waktu modifikasi terakhir sumber daya (UTC) |
lastModifiedBy |
string |
Identitas yang terakhir memodifikasi sumber daya. |
lastModifiedByType |
Jenis identitas yang terakhir mengubah sumber daya. |