Policy Set Definition Versions - List By Management Group

Referência

Service:: Policy

API Version:: 2023-04-01

Obtém todas as versões de definição do conjunto de políticas para uma determinada definição de conjunto de políticas num grupo de gestão.
Esta operação obtém uma lista de todas as versões de definição do conjunto de políticas para a definição de conjunto de políticas especificada num determinado grupo de gestão.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
managementGroupName	path	True	string	O nome do grupo de gestão. O nome não é sensível a maiúsculas e minúsculas.
policySetDefinitionName	path	True	string	O nome da definição do conjunto de políticas. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
api-version	query	True	string	A versão da API a utilizar para esta operação.
$top	query		integer int32	Número máximo de registos a devolver. Quando o filtro $top não for fornecido, irá devolver 500 registos.

Respostas

Name	Tipo	Description
200 OK	PolicySetDefinitionVersionListResult	OK - Devolve uma matriz de versões de definição de conjuntos de políticas.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List policy set definitions at management group level

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/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_set_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="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="CostManagement",
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.policy_set_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/listPolicySetDefinitionVersionsByManagementGroup.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/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",
        "policyDefinitions": [
          {
            "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

Definições

Name	Description
CloudError	Uma resposta de erro de uma operação de política.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
Metadata	Metadados gerais para o parâmetro .
ParameterDefinitionsValue	A definição de um parâmetro que pode ser fornecido à política.
parameterType	O tipo de dados do parâmetro .
ParameterValuesValue	O valor de um parâmetro.
PolicyDefinitionGroup	O grupo de definição de política.
PolicyDefinitionReference	A referência de definição de política.
PolicySetDefinitionVersion	A versão de definição do conjunto de políticas.
PolicySetDefinitionVersionListResult	Lista de versões de definição de conjuntos de políticas.
policyType	O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
systemData	Metadados relativos à criação e última modificação do recurso.

CloudError

Uma resposta de erro de uma operação de política.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.)

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorResponse

Resposta a Erros

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

Metadata

Metadados gerais para o parâmetro .

Name	Tipo	Description
assignPermissions	boolean	Defina como verdadeiro para ter portal do Azure criar atribuições de funções no ID do recurso ou no valor do âmbito do recurso deste parâmetro durante a atribuição de política. Esta propriedade é útil caso pretenda atribuir permissões fora do âmbito de atribuição.
description	string	A descrição do parâmetro .
displayName	string	O nome a apresentar do parâmetro .
strongType	string	Utilizado ao atribuir a definição de política através do portal. Fornece uma lista com deteção de contexto de valores para o utilizador escolher.

ParameterDefinitionsValue

A definição de um parâmetro que pode ser fornecido à política.

Name	Tipo	Description
allowedValues	object[]	Os valores permitidos para o parâmetro .
defaultValue	object	O valor predefinido para o parâmetro se não for fornecido nenhum valor.
metadata	Metadata	Metadados gerais para o parâmetro .
schema	object	Fornece a validação de entradas de parâmetros durante a atribuição com um esquema JSON autodefinido. Esta propriedade só é suportada para parâmetros de tipo de objeto e segue a implementação Json.NET Schema 2019-09. Pode saber mais sobre como utilizar esquemas em https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/.
type	parameterType	O tipo de dados do parâmetro .

parameterType

O tipo de dados do parâmetro .

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

ParameterValuesValue

O valor de um parâmetro.

Name	Tipo	Description
value	object	O valor do parâmetro .

PolicyDefinitionGroup

O grupo de definição de política.

Name	Tipo	Description
additionalMetadataId	string	Um ID de recurso de um recurso que contém metadados adicionais sobre o grupo.
category	string	A categoria do grupo.
description	string	A descrição do grupo.
displayName	string	O nome a apresentar do grupo.
name	string	O nome do grupo.

PolicyDefinitionReference

A referência de definição de política.

Name	Tipo	Description
groupNames	string[]	O nome dos grupos a que esta referência de definição de política pertence.
parameters	<string, ParameterValuesValue>	Os valores dos parâmetros da regra de política referenciada. As chaves são os nomes dos parâmetros.
policyDefinitionId	string	O ID da definição de política ou definição do conjunto de políticas.
policyDefinitionReferenceId	string	Um ID exclusivo (dentro da definição do conjunto de políticas) para esta referência de definição de política.