Policy Set Definition Versions - Get

Служба:: Policy

Версия API:: 2025-11-01

Эта операция получает версию определения набора политик в данной подписке с именем и версией.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2025-11-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion}?api-version=2025-11-01&$expand={$expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
policyDefinitionVersion	path	True	string pattern: ^\d+\.\d+\.\d+$	Версия определения набора политик. Формат — x.y.z, где x — основной номер версии, y — минорный номер версии, z — патч
policySetDefinitionName	path	True	string pattern: ^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$	Название определения набора политик.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$expand	query		string	Список дополнительных свойств с разделёнными запятыми для включения в ответ. Поддерживаемые значения: 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

Ответы

Имя	Тип	Описание
200 OK	PolicySetDefinitionVersion	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Retrieve a policy set definition version

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1?api-version=2025-11-01

Пример ответа

Код состояния:: 200

{
  "name": "1.2.1",
  "type": "Microsoft.Authorization/policySetDefinitions/versions",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
  "properties": {
    "description": "Policies to enforce low cost storage SKUs",
    "displayName": "Cost Management",
    "metadata": {
      "category": "Cost Management"
    },
    "policyDefinitionGroups": [
      {
        "name": "CostSaving",
        "description": "Policies designed to control spend within a subscription.",
        "displayName": "Cost Management Policies"
      },
      {
        "name": "Organizational",
        "description": "Policies that help enforce resource organization standards within a subscription.",
        "displayName": "Organizational Policies"
      }
    ],
    "policyDefinitions": [
      {
        "definitionVersion": "1.*.*",
        "groupNames": [
          "CostSaving"
        ],
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus"
      },
      {
        "definitionVersion": "1.*.*",
        "groupNames": [
          "Organizational"
        ],
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming"
      }
    ],
    "version": "1.2.1"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ParameterDefinitionsValue	Определение параметра, который может быть предоставлен политике.
ParameterDefinitionsValueMetadata	Общие метаданные параметра.
ParameterType	Тип данных параметра.
ParameterValuesValue	Значение параметра.
PolicyDefinitionGroup	Группа определения политики.
PolicyDefinitionReference	Ссылка на определение политики.
PolicySetDefinitionVersion	Версия определения набора политик.
PolicyType	Тип определения политики. Возможные значения: NotSpecified, BuiltIn, Custom и Static.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ParameterDefinitionsValue

Объект

Определение параметра, который может быть предоставлен политике.

Имя	Тип	Описание
allowedValues	AllowedValues[]	Допустимые значения параметра.
defaultValue		Значение по умолчанию для параметра, если значение не указано.
metadata	ParameterDefinitionsValueMetadata	Общие метаданные параметра.
schema		Обеспечивает проверку входных данных параметров во время назначения с помощью самоопределимой схемы JSON. Это свойство поддерживается только для параметров объектного типа и следует реализации схемы Json.NET 2019-09. Вы можете просмотреть дополнительные сведения об использовании схем на сайте https://json-schema.org/ и протестировать черновые версии схем на сайте https://www.jsonschemavalidator.net/.
type	ParameterType	Тип данных параметра.

ParameterDefinitionsValueMetadata

Объект

Общие метаданные параметра.

Имя	Тип	Описание
assignPermissions	boolean	Установите true так, чтобы Azure portal создавал назначения ролей на идентификаторе ресурса или значении области ресурса этого параметра во время назначения политики. Это свойство полезно, если вы хотите назначить разрешения за пределами области назначения.
description	string	Описание параметра.
displayName	string	Отображаемое имя параметра.
strongType	string	Используется при назначении определения политики через портал. Предоставляет контекстный список значений, которые пользователь выбирает.

ParameterType

Перечисление

Тип данных параметра.

Значение	Описание
String	Тип параметра строки.
Array	Тип параметра массива.
Object	Тип параметра объекта.
Boolean	Тип булевых параметров.
Integer	Тип параметра целого числа.
Float	Тип параметра float.
DateTime	Тип параметра дата-время.

ParameterValuesValue

Объект

Значение параметра.

Имя	Тип	Описание
value		Значение параметра.

PolicyDefinitionGroup

Объект

Группа определения политики.

Имя	Тип	Описание
additionalMetadataId	string	Идентификатор ресурса ресурса, содержащего дополнительные метаданные о группе.
category	string	Категория группы.
description	string	Описание группы.
displayName	string	Отображаемое имя группы.
name	string	Имя группы.

PolicyDefinitionReference

Объект

Ссылка на определение политики.

Имя	Тип	Описание
definitionVersion	string	Версия используемого определения политики.
effectiveDefinitionVersion	string	Эффективная версия используемого определения политики. Это происходит только при запросе через параметр запроса $expand.
groupNames	string[]	Имя групп, к которым относится ссылка на определение политики.
latestDefinitionVersion	string	Последняя версия определения полиса доступна. Это происходит только при запросе через параметр запроса $expand.
parameters	<string, ParameterValuesValue>	Значения параметров для указанного правила политики. Ключи — это имена параметров.
policyDefinitionId	string	Идентификатор определения политики или определения набора политик.
policyDefinitionReferenceId	string	Уникальный идентификатор (в определении набора политик) для этой ссылки на определение политики.