Policy Definitions - Get At Management Group

Yönetim grubunda bir ilke tanımı alın.
Bu işlem, verilen yönetim grubunda verilen adla ilke tanımını alır.

GET https://management.azure.com/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}?api-version=2019-09-01

URI Parametreleri

Name In Required Type Description
managementGroupId
path True
  • string

Yönetim grubunun kimliği.

policyDefinitionName
path True
  • string

Almak için ilke tanımının adı.

api-version
query True
  • string

İşlem için kullanılacak API sürümü.

Yanıtlar

Name Type Description
200 OK

Tamam - İlke tanımı hakkında bilgi verir.

Other Status Codes

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akış

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızı niçin taklit edin

Örnekler

Retrieve a policy definition at management group level

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming?api-version=2019-09-01

Sample Response

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
  "type": "Microsoft.Authorization/policyDefinitions",
  "name": "ResourceNaming",
  "properties": {
    "mode": "All",
    "displayName": "Naming Convention",
    "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
    "metadata": {
      "category": "Naming"
    },
    "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"
  }
}

Tanımlar

CloudError

İlke işleminden gelen bir hata yanıtı.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgi.

ErrorResponse

Kaynak yönetimi hata yanıtı.

Metadata

Parametre için genel meta veriler.

ParameterDefinitionsValue

İlke sağlanabilir bir parametre tanımı.

parameterType

Parametrenin veri türü.

PolicyDefinition

İlke tanımı.

policyType

İlke tanımının türü. Olası değerler Notspecified, BuiltIn, Custom ve Static'dir.

CloudError

İlke işleminden gelen bir hata yanıtı.

Name Type Description
error

Kaynak yönetimi hata yanıtı.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgi.

Name Type Description
info
  • object

Ek bilgi.

type
  • string

Ek bilgi türü.

ErrorResponse

Kaynak yönetimi hata yanıtı.

Name Type Description
additionalInfo

Hata ek bilgi.

code
  • string

Hata kodu.

details

Hata ayrıntıları.

message
  • string

Hata iletisi.

target
  • string

Hata hedefi.

Metadata

Parametre için genel meta veriler.

Name Type Description
description
  • string

Parametrenin açıklaması.

displayName
  • string

Parametrenin görüntü adı.

ParameterDefinitionsValue

İlke sağlanabilir bir parametre tanımı.

Name Type Description
allowedValues
  • object[]

Parametre için izin verilen değerler.

defaultValue
  • object

Değer sağlanmadıysa parametrenin varsayılan değeri.

metadata

Parametre için genel meta veriler.

type

Parametrenin veri türü.

parameterType

Parametrenin veri türü.

Name Type Description
Array
  • string
Boolean
  • string
DateTime
  • string
Float
  • string
Integer
  • string
Object
  • string
String
  • string

PolicyDefinition

İlke tanımı.

Name Type Description
id
  • string

İlke tanımının kimliği.

name
  • string

İlke tanımının adı.

properties.description
  • string

İlke tanımı açıklaması.

properties.displayName
  • string

İlke tanımının görüntü adı.

properties.metadata
  • object

İlke tanımı meta verileri. Meta veriler açık uçlu bir nesnedir ve genellikle anahtar değer çiftleri topluluğudur.

properties.mode
  • string

İlke tanımı modu. Bazı örnekler Tüm, Dizinlenmiş, Microsoft.KeyVault.Data vardır.

properties.parameters

İlke kuralında kullanılan parametreler için parametre tanımları. Anahtarlar parametre adlarıdır.

properties.policyRule
  • object

İlke kuralı.

properties.policyType

İlke tanımının türü. Olası değerler Notspecified, BuiltIn, Custom ve Static'dir.

type
  • string

Kaynağın türü (Microsoft.Authorization/policyDefinitions).

policyType

İlke tanımının türü. Olası değerler Notspecified, BuiltIn, Custom ve Static'dir.

Name Type Description
BuiltIn
  • string
Custom
  • string
NotSpecified
  • string
Static
  • string