Policy Definition Versions - List By Management Group

Referencia

Service:: Policy

API Version:: 2023-04-01

Recupere las versiones de definición de directiva en una definición de directiva de grupo de administración.
Esta operación recupera una lista de todas las versiones de definición de directiva para la definición de directiva especificada en el grupo de administración determinado.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}/versions?api-version=2023-04-01&$top={$top}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
managementGroupName	path	True	string	Nombre del grupo de administración. El nombre distingue mayúsculas de minúsculas.
policyDefinitionName	path	True	string	Nombre de la definición de directiva. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	Versión de API que se usará para la operación.
$top	query		integer int32	Número máximo de registros que se van a devolver. Cuando no se proporcione el filtro $top, devolverá 500 registros.

Respuestas

Nombre	Tipo	Description
200 OK	PolicyDefinitionVersionListResult	Ok: devuelve una matriz de versiones de definición de directiva.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List policy definition versions by management group

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions?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_definition_versions_by_management_group.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(),
        policy_definition_name="ResourceNaming",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_definition_versions.list_by_management_group(
        management_group_name="MyManagementGroup",
    )
    for item in response:
        print(item)


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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.2.1",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.2.1",
      "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",
        "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": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming/versions/1.0.0",
      "type": "Microsoft.Authorization/policyDefinitions/versions",
      "name": "1.0.0",
      "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",
        "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"
      }
    }
  ]
}

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	El tipo de datos del parámetro.
PolicyDefinitionVersion	Identificador de la versión de definición de directiva.
PolicyDefinitionVersionListResult	Lista de versiones de definición de directiva.
policyType	Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static.
systemData	Metadatos relacionados con la creación y la ú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[]	Los detalles del error.
message	string	El 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 directiva. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación.
description	string	La 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 debe 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 2019-09 del esquema Json.NET. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar borradores de esquemas en https://www.jsonschemavalidator.net/.
type	parameterType	El tipo de datos del parámetro.

parameterType

El tipo de datos del parámetro.

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