Policy Definitions - List

Servizio:

Policy

Versione API:

2023-04-01

Recupera le definizioni dei criteri in una sottoscrizione
Questa operazione recupera un elenco di tutte le definizioni dei criteri in una determinata sottoscrizione che corrispondono alla $filter facoltativa specificata. I valori validi per $filter sono: 'atExactScope()', 'policyType -eq {value}' o 'category eq '{value}'. Se $filter non viene fornito, l'elenco non filtrato include tutte le definizioni di criteri associate alla sottoscrizione, incluse quelle che si applicano direttamente o dai gruppi di gestione che contengono la sottoscrizione specificata. Se $filter=atExactScope() viene fornito, l'elenco restituito include solo tutte le definizioni dei criteri in corrispondenza della sottoscrizione specificata. Se viene fornito $filter='policyType -eq {value}', l'elenco restituito include solo tutte le definizioni dei criteri il cui tipo corrisponde al {value}. I valori policyType possibili sono NotSpecified, BuiltIn, Custom e Static. Se viene specificato $filter='category -eq {value}', l'elenco restituito include solo tutte le definizioni dei criteri la cui categoria corrisponde al {value}.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$filter	query		string	Filtro da applicare all'operazione. I valori validi per $filter sono: 'atExactScope()', 'policyType -eq {value}' o 'category eq '{value}'. Se $filter non viene fornito, non viene eseguito alcun filtro. Se $filter=atExactScope() viene fornito, l'elenco restituito include solo tutte le definizioni dei criteri presenti nell'ambito specificato. Se viene fornito $filter='policyType -eq {value}', l'elenco restituito include solo tutte le definizioni dei criteri il cui tipo corrisponde al {value}. I valori policyType possibili sono NotSpecified, BuiltIn, Custom e Static. Se viene specificato $filter='category -eq {value}', l'elenco restituito include solo tutte le definizioni dei criteri la cui categoria corrisponde al {value}.
$top	query		integer int32	Numero massimo di record da restituire. Quando il filtro $top non viene fornito, restituirà 500 record.

Risposte

Nome	Tipo	Descrizione
200 OK	PolicyDefinitionListResult	OK: restituisce una matrice di definizioni dei criteri.
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List policy definitions by subscription

Esempio di richiesta

HTTP

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

Python

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_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(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="POLICY_SET_DEFINITION_NAME",
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_definitions.list()
    for item in response:
        print(item)


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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "properties": {
        "mode": "All",
        "displayName": "Allowed storage account SKUs",
        "policyType": "BuiltIn",
        "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.",
        "parameters": {
          "listOfAllowedSKUs": {
            "type": "Array",
            "metadata": {
              "description": "The list of SKUs that can be specified for storage accounts.",
              "displayName": "Allowed SKUs",
              "strongType": "StorageSKUs"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "allOf": [
              {
                "field": "type",
                "equals": "Microsoft.Storage/storageAccounts"
              },
              {
                "not": {
                  "field": "Microsoft.Storage/storageAccounts/sku.name",
                  "in": "[parameters('listOfAllowedSKUs')]"
                }
              }
            ]
          },
          "then": {
            "effect": "Deny"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "ResourceNaming"
    },
    {
      "properties": {
        "mode": "Microsoft.KeyVault.Data",
        "displayName": "Audit KeyVault certificates that expire within specified number of days",
        "description": "Audit certificates that are stored in Azure Key Vault, that expire within 'X' number of days.",
        "metadata": {
          "category": "KeyVault DataPlane"
        },
        "parameters": {
          "daysToExpire": {
            "type": "Integer",
            "metadata": {
              "displayName": "Days to expire",
              "description": "The number of days for a certificate to expire."
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "field": "Microsoft.KeyVault.Data/vaults/certificates/attributes/expiresOn",
            "lessOrEquals": "[addDays(utcNow(), parameters('daysToExpire'))]"
          },
          "then": {
            "effect": "audit"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/AuditSoonToExpireCerts",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "AuditSoonToExpireCerts"
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore da un'operazione di criteri.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorResponse	Risposta di errore
Metadata	Metadati generali per il parametro.
ParameterDefinitionsValue	Definizione di un parametro che può essere fornito ai criteri.
parameterType	Tipo di dati del parametro.
PolicyDefinition	Definizione dei criteri.
PolicyDefinitionListResult	Elenco delle definizioni dei criteri.
policyType	Tipo di definizione dei criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Risposta di errore da un'operazione di criteri.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

Metadata

Metadati generali per il parametro.

Nome	Tipo	Descrizione
assignPermissions	boolean	Impostare su true per avere portale di Azure creare assegnazioni di ruolo nel valore dell'ID risorsa o dell'ambito della risorsa di questo parametro durante l'assegnazione dei criteri. Questa proprietà è utile nel caso in cui si desideri assegnare autorizzazioni al di fuori dell'ambito di assegnazione.
description	string	Descrizione del parametro.
displayName	string	Nome visualizzato per il parametro.
strongType	string	Usato per assegnare la definizione dei criteri tramite il portale. Fornisce un elenco di valori con riconoscimento del contesto da cui scegliere l'utente.

ParameterDefinitionsValue

Definizione di un parametro che può essere fornito ai criteri.

Nome	Tipo	Descrizione
allowedValues	object[]	Valori consentiti per il parametro.
defaultValue	object	Valore predefinito per il parametro se non viene specificato alcun valore.
metadata	Metadata	Metadati generali per il parametro.
schema	object	Fornisce la convalida degli input dei parametri durante l'assegnazione usando uno schema JSON auto-definito. Questa proprietà è supportata solo per i parametri di tipo oggetto e segue l'implementazione dello schema Json.NET schema 2019-09. Per altre informazioni sull'uso di schemi https://json-schema.org/ in e schemi di test, vedere https://www.jsonschemavalidator.net/.
type	parameterType	Tipo di dati del parametro.

parameterType

Tipo di dati del parametro.

Nome	Tipo	Descrizione
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

PolicyDefinition

Definizione dei criteri.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID della definizione dei criteri.
name	string		Nome della definizione dei criteri.
properties.description	string		Descrizione della definizione dei criteri.
properties.displayName	string		Nome visualizzato della definizione dei criteri.
properties.metadata	object		Metadati della definizione dei criteri. I metadati sono un oggetto terminato aperto ed è in genere una raccolta di coppie di valori chiave.
properties.mode	string	Indexed	Modalità di definizione dei criteri. Alcuni esempi sono Tutti, Indicizzati, Microsoft.KeyVault.Data.
properties.parameters	<string,  ParameterDefinitionsValue>		Definizioni dei parametri per i parametri usati nella regola dei criteri. Le chiavi sono i nomi dei parametri.
properties.policyRule	object		Regola dei criteri.
properties.policyType	policyType		Tipo di definizione dei criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.
properties.version	string		Versione della definizione dei criteri in formato #.#.#.
properties.versions	string[]		Elenco delle versioni disponibili per questa definizione di criterio.
systemData	systemData		Metadati di sistema relativi a questa risorsa.
type	string		Tipo della risorsa (Microsoft.Authorization/policyDefinitions).

PolicyDefinitionListResult

Elenco delle definizioni dei criteri.

Nome	Tipo	Descrizione
nextLink	string	URL da usare per ottenere il set successivo di risultati.
value	PolicyDefinition[]	Matrice di definizioni di criteri.

policyType

Tipo di definizione dei criteri. I valori possibili sono NotSpecified, BuiltIn, Custom e Static.

Nome	Tipo	Descrizione
BuiltIn	string
Custom	string
NotSpecified	string
Static	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.