Policy Set Definitions - List

Referencia

Servicio:: Policy

Versión de la API:: 2023-04-01

Recupera las definiciones del conjunto de directivas de una suscripción.
Esta operación recupera una lista de todas las definiciones del conjunto de directivas de una suscripción determinada que coinciden con el $filter opcional especificado. Los valores válidos para $filter son: 'atExactScope()', 'policyType -eq {value}' o 'category eq '{value}'. Si no se proporciona $filter, la lista sin filtrar incluye todas las definiciones de conjunto de directivas asociadas a la suscripción, incluidas las que se aplican directamente o desde grupos de administración que contienen la suscripción especificada. Si se proporciona $filter=atExactScope(), la lista devuelta solo incluye todas las definiciones del conjunto de directivas que se encuentra en la suscripción especificada. Si se proporciona $filter='policyType -eq {value}', la lista devuelta solo incluye todas las definiciones del conjunto de directivas cuyo tipo coincida con {value}. Los valores policyType posibles son NotSpecified, BuiltIn y Custom. Si se proporciona $filter='category -eq {value}', la lista devuelta solo incluye todas las definiciones del conjunto de directivas cuya categoría coincida con {value}.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
$expand	query		string	Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores admitidos son "LatestDefinitionVersion, EffectiveDefinitionVersion".
$filter	query		string	Filtro que se va a aplicar en la operación. Los valores válidos para $filter son: 'atExactScope()', 'policyType -eq {value}' o 'category eq '{value}'. Si no se proporciona $filter, no se realiza ningún filtrado. Si se proporciona $filter=atExactScope(), la lista devuelta solo incluye todas las definiciones del conjunto de directivas que están en el ámbito especificado. Si se proporciona $filter='policyType -eq {value}', la lista devuelta solo incluye todas las definiciones del conjunto de directivas cuyo tipo coincida con {value}. Los valores policyType posibles son NotSpecified, BuiltIn, Custom y Static. Si se proporciona $filter='category -eq {value}', la lista devuelta solo incluye todas las definiciones del conjunto de directivas cuya categoría coincida con {value}.
$top	query		integer int32	Número máximo de registros que se van a devolver. Cuando no se proporciona el filtro $top, devolverá 500 registros.

Respuestas

Nombre	Tipo	Description
200 OK	PolicySetDefinitionListResult	Aceptar: devuelve una matriz de definiciones de conjuntos de directivas.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List policy set definitions

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions?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 list_policy_set_definitions.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_definitions.list()
    for item in response:
        print(item)


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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "properties": {
        "displayName": "[Preview]: Enable Monitoring in Azure Security Center",
        "policyType": "BuiltIn",
        "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.",
        "metadata": {
          "category": "Security Center"
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "parameters": {},
        "policyDefinitions": [
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId1"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId2"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId3"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId4"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId5"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId6"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId7"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId8"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId9"
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "RefId10"
          }
        ]
      },
      "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
      "type": "Microsoft.Authorization/policySetDefinitions",
      "name": "CostManagement",
      "properties": {
        "displayName": "Cost Management",
        "description": "Policies to enforce low cost storage SKUs",
        "metadata": {
          "category": "Cost Management"
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyDefinitions": [
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "definitionVersion": "1.*.*",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Respuesta de error de una operación de directiva.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
Metadata	Metadatos generales para el parámetro .
ParameterDefinitionsValue	Definición de un parámetro que se puede proporcionar a la directiva.
parameterType	Tipo de datos del parámetro.
ParameterValuesValue	Valor de un parámetro.
PolicyDefinitionGroup	Grupo de definición de directiva.
PolicyDefinitionReference	Referencia de definición de directiva.
PolicySetDefinition	Definición del conjunto de directivas.
PolicySetDefinitionListResult	Lista de definiciones de conjuntos de directivas.
policyType	Tipo de definición del conjunto de directivas. Los valores posibles son NotSpecified, BuiltIn, Custom y Static.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CloudError

Respuesta de error de una operación de directiva.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

Metadata

Metadatos generales para el parámetro .

Nombre	Tipo	Description
assignPermissions	boolean	Establézcalo en true para que Azure Portal cree asignaciones de roles en el identificador de recurso o el valor de ámbito de recurso de este parámetro durante la asignación de directivas. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación.
description	string	Descripción del parámetro .
displayName	string	Nombre para mostrar del parámetro.
strongType	string	Se usa al asignar la definición de directiva a través del portal. Proporciona una lista con reconocimiento de contexto de valores entre los que el usuario puede elegir.

ParameterDefinitionsValue

Definición de un parámetro que se puede proporcionar a la directiva.

Nombre	Tipo	Description
allowedValues	object[]	Valores permitidos para el parámetro .
defaultValue	object	Valor predeterminado del parámetro si no se proporciona ningún valor.
metadata	Metadata	Metadatos generales para el parámetro .
schema	object	Proporciona validación de entradas de parámetro durante la asignación mediante un esquema JSON autodefinido. Esta propiedad solo se admite para los parámetros de tipo de objeto y sigue la implementación del esquema de Json.NET 2019-09. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas de borrador en https://www.jsonschemavalidator.net/.
type	parameterType	Tipo de datos del parámetro.

parameterType

Tipo de datos del parámetro.

Nombre	Tipo	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Valor de un parámetro.

Nombre	Tipo	Description
value	object	Valor del parámetro .

PolicyDefinitionGroup

Grupo de definición de directiva.

Nombre	Tipo	Description
additionalMetadataId	string	Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo.
category	string	Categoría del grupo.
description	string	Descripción del grupo.
displayName	string	Nombre para mostrar del grupo.
name	string	Nombre del grupo.

PolicyDefinitionReference

Referencia de definición de directiva.

Nombre	Tipo	Description
definitionVersion	string	Versión de la definición de directiva que se va a usar.
effectiveDefinitionVersion	string	Versión efectiva de la definición de directiva en uso. Esto solo está presente si se solicita a través del parámetro de consulta $expand.
groupNames	string[]	Nombre de los grupos a los que pertenece esta referencia de definición de directiva.
latestDefinitionVersion	string	La versión más reciente de la definición de directiva disponible. Esto solo está presente si se solicita a través del parámetro de consulta $expand.
parameters	<string, ParameterValuesValue>	Valores de parámetro para la regla de directiva a la que se hace referencia. Las claves son los nombres de parámetro.
policyDefinitionId	string	Identificador de la definición de directiva o definición del conjunto de directivas.
policyDefinitionReferenceId	string	Identificador único (dentro de la definición del conjunto de directivas) para esta referencia de definición de directiva.