Policy Set Definitions - Get

Référence

Service:: Policy

Version d'API:: 2023-04-01

Récupère une définition d’ensemble de stratégies.
Cette opération récupère la définition du jeu de stratégies dans l’abonnement donné avec le nom donné.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
policySetDefinitionName	path	True	string	Nom de la définition du jeu de stratégies à obtenir. Modèle d’expression régulière: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$expand	query		string	Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse. Les valeurs prises en charge sont « LatestDefinitionVersion, EffectiveDefinitionVersion ».

Réponses

Nom	Type	Description
200 OK	PolicySetDefinition	OK : retourne des informations sur la définition du jeu de stratégies.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Retrieve a policy set definition

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement?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.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.get(
        policy_set_definition_name="CostManagement",
    )
    print(response)


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

Exemple de réponse

Code d’état:: 200

{
  "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"
    ],
    "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"
          }
        }
      }
    ]
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur d’une opération de stratégie.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
Metadata	Métadonnées générales pour le paramètre.
ParameterDefinitionsValue	Définition d’un paramètre pouvant être fourni à la stratégie.
parameterType	Type de données du paramètre.
ParameterValuesValue	Valeur d’un paramètre.
PolicyDefinitionGroup	Groupe de définitions de stratégie.
PolicyDefinitionReference	Référence de définition de stratégie.
PolicySetDefinition	Définition du jeu de stratégies.
policyType	Type de définition du jeu de stratégies. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Réponse d’erreur d’une opération de stratégie.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

Metadata

Métadonnées générales pour le paramètre.

Nom	Type	Description
assignPermissions	boolean	Définissez la valeur true pour que le portail Azure crée des attributions de rôles sur l’ID de ressource ou la valeur d’étendue de ressource de ce paramètre pendant l’attribution de stratégie. Cette propriété est utile si vous souhaitez attribuer des autorisations en dehors de l’étendue d’affectation.
description	string	Description du paramètre.
displayName	string	Nom complet du paramètre.
strongType	string	Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle des valeurs à choisir pour l’utilisateur.

ParameterDefinitionsValue

Définition d’un paramètre pouvant être fourni à la stratégie.

Nom	Type	Description
allowedValues	object[]	Valeurs autorisées pour le paramètre.
defaultValue	object	Valeur par défaut du paramètre si aucune valeur n’est fournie.
metadata	Metadata	Métadonnées générales pour le paramètre.
schema	object	Fournit la validation des entrées de paramètre pendant l’affectation à l’aide d’un schéma JSON autodéfinis. Cette propriété est uniquement prise en charge pour les paramètres de type objet et suit l’implémentation Json.NET Schema 2019-09. Vous pouvez en savoir plus sur l’utilisation de schémas à https://json-schema.org/ et tester des schémas brouillons à https://www.jsonschemavalidator.net/.
type	parameterType	Type de données du paramètre.

parameterType

Type de données du paramètre.

Nom	Type	Description
Array	string
Boolean	string
DateTime	string
Float	string
Integer	string
Object	string
String	string

ParameterValuesValue

Valeur d’un paramètre.

Nom	Type	Description
value	object	Valeur du paramètre.

PolicyDefinitionGroup

Groupe de définitions de stratégie.

Nom	Type	Description
additionalMetadataId	string	ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe.
category	string	Catégorie du groupe.
description	string	Description du groupe.
displayName	string	Nom complet du groupe.
name	string	Nom du groupe.

PolicyDefinitionReference

Référence de définition de stratégie.

Nom	Type	Description
definitionVersion	string	Version de la définition de stratégie à utiliser.
effectiveDefinitionVersion	string	Version effective de la définition de stratégie en cours d’utilisation. Ceci n’est présent que s’il est demandé via le paramètre de requête $expand.
groupNames	string[]	Nom des groupes auxquels appartient cette référence de définition de stratégie.
latestDefinitionVersion	string	Dernière version de la définition de stratégie disponible. Ceci n’est présent que s’il est demandé via le paramètre de requête $expand.
parameters	<string, ParameterValuesValue>	Valeurs des paramètres de la règle de stratégie référencée. Les clés sont les noms de paramètres.
policyDefinitionId	string	ID de la définition de stratégie ou de la définition de jeu de stratégies.
policyDefinitionReferenceId	string	ID unique (dans la définition du jeu de stratégies) pour cette référence de définition de stratégie.