Policy Set Definition Versions - Get

Ссылка

Служба:: Policy

Версия API:: 2023-04-01

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

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

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

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

Параметры 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	ОК. Возвращает сведения о версии определения набора политик.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

Retrieve a policy set definition version

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_policy_set_definition_version.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(),
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_set_definition_versions.get(
        policy_set_definition_name="CostManagement",
        policy_definition_version="1.2.1",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/getPolicySetDefinitionVersion.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

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

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

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

Определения

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

CloudError

Object

Ответ на ошибку из операции политики.

Имя	Тип	Описание
error	ErrorResponse	Ответ на ошибку Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку OData.)

createdByType

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

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

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

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

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

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

Metadata

Object

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

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

ParameterDefinitionsValue

Object

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

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

parameterType

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

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

Значение	Описание
Array
Boolean
DateTime
Float
Integer
Object
String

ParameterValuesValue

Object

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

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

PolicyDefinitionGroup

Object

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

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

PolicyDefinitionReference

Object

Справочник по определению политики.

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