Compartilhar via

Policy Definitions - List By Management Group

  • Referência
Serviço:
Policy
Versão da API:
2023-04-01

Recuperar definições de política em um grupo de gerenciamento
Essa operação recupera uma lista de todas as definições de política em um determinado grupo de gerenciamento que correspondem à $filter opcional fornecida. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas ao grupo de gerenciamento, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm o grupo de gerenciamento fornecido. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no grupo de gerenciamento fornecido. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01
Com parâmetros opcionais: 
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
managementGroupId
 path True

string

A ID do grupo de gerenciamento.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
$filter
 query

string

O filtro a ser aplicado na operação. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, nenhuma filtragem será executada. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no escopo especificado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponde ao {value}.
$top
 query

integer (int32)

minimum: 1
maximum: 1000

Número máximo de registros a serem retornados. Quando o filtro de $top não for fornecido, ele retornará 500 registros.

Respostas

Nome Tipo Description
200 OK

PolicyDefinitionListResult

OK - Retorna uma matriz de definições de política.
Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

List policy definitions by management group

Solicitação de exemplo

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01

Resposta de exemplo

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

Definições

Nome Description
CloudError

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

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse

Resposta de erro
Metadata

Metadados gerais para o parâmetro.
ParameterDefinitionsValue

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

O tipo de dados do parâmetro.
PolicyDefinition

A definição de política.
PolicyDefinitionListResult

Lista de definições de política.
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

Objeto

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

Nome Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Objeto

Resposta de erro

Nome 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

Objeto

Metadados gerais para o parâmetro.

Nome Tipo Description
assignPermissions

boolean

Defina como true para que o portal do Azure crie atribuições de função na ID do recurso ou no valor do escopo do recurso desse parâmetro durante a atribuição de política. Essa propriedade é útil caso você deseje atribuir permissões fora do escopo de atribuição.
description

string

A descrição do parâmetro.
displayName

string

O nome de exibição do parâmetro.
strongType

string

Usado ao atribuir a definição de política por meio do portal. Fornece uma lista de valores com reconhecimento de contexto para o usuário escolher.

ParameterDefinitionsValue

Objeto

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

Nome Tipo Description
allowedValues

object[]

Os valores permitidos para o parâmetro.
defaultValue

object

O valor padrão do parâmetro se nenhum valor for fornecido.
metadata

Metadata

Metadados gerais para o parâmetro.
schema

object

Fornece a validação de entradas de parâmetro durante a atribuição usando um esquema JSON autodefinido. Essa propriedade só tem suporte para parâmetros do tipo objeto e segue a implementação Json.NET Schema 2019-09. Você pode saber mais sobre como usar esquemas no https://json-schema.org/ e testar esquemas de rascunho em https://www.jsonschemavalidator.net/.
type

parameterType

O tipo de dados do parâmetro.

parameterType

Enumeração

O tipo de dados do parâmetro.

Valor Description
Array
Boolean
DateTime
Float
Integer
Object
String

PolicyDefinition

Objeto

A definição de política.

Nome Tipo Valor padrão Description
id

string

A ID da definição de política.
name

string

O nome da definição de política.
properties.description

string

A descrição da definição de política.
properties.displayName

string

O nome de exibição da definição de política.
properties.metadata

object

Os metadados de definição de política. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave.
properties.mode

string

Indexed

O modo de definição de política. Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data.
properties.parameters

<string,  ParameterDefinitionsValue>

As definições de parâmetro para parâmetros usados na regra de política. As chaves são os nomes dos parâmetros.
properties.policyRule

object

A regra de política.
properties.policyType

policyType

O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
properties.version

string

A versão de definição de política no formato #.#.#.
properties.versions

string[]

Uma lista de versões disponíveis para essa definição de política.
systemData

systemData

Os metadados do sistema relacionados a esse recurso.
type

string

O tipo do recurso (Microsoft.Authorization/policyDefinitions).

PolicyDefinitionListResult

Objeto

Lista de definições de política.

Nome Tipo Description
nextLink

string

A URL a ser usada para obter o próximo conjunto de resultados.
value

PolicyDefinition[]

Uma matriz de definições de política.

policyType

Enumeração

O tipo de definição de política. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.

Valor Description
BuiltIn
Custom
NotSpecified
Static

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.