Policy Restrictions - Check At Management Group Scope

Referência

Serviço:: Policy

Versão da API:: 2023-03-01

Verifica quais restrições Azure Policy colocarão nos recursos dentro de um grupo de gerenciamento.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
managementGroupId	path	True	string	ID do grupo de gerenciamento.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
pendingFields	PendingField[]	A lista de campos e valores que devem ser avaliados quanto a possíveis restrições.
resourceDetails	CheckRestrictionsResourceDetails	As informações sobre o recurso que serão avaliadas.

Respostas

Nome	Tipo	Description
200 OK	CheckRestrictionsResult	As restrições que serão colocadas no recurso por Azure Policy.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do 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

Check policy restrictions at management group scope

Solicitação de exemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/checkPolicyRestrictions?api-version=2023-03-01

{
  "pendingFields": [
    {
      "field": "type"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "fieldRestrictions": [
    {
      "field": "type",
      "restrictions": [
        {
          "result": "Required",
          "values": [
            "Microsoft.Compute/virtualMachines"
          ],
          "policy": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyDefinitions/allowedTypes",
            "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyAssignments/7EB1508A",
            "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policySetDefinitions/735551F1",
            "policyDefinitionReferenceId": "DefRef"
          },
          "policyEffect": "Deny",
          "reason": "type not allowed"
        }
      ]
    }
  ],
  "contentEvaluationResult": {
    "policyEvaluations": []
  }
}

Definições

Nome	Description
CheckManagementGroupRestrictionsRequest	O marcar parâmetros de restrições de política que descrevem o recurso que está sendo avaliado.
CheckRestrictionEvaluationDetails	Detalhes da avaliação da política.
CheckRestrictionsResourceDetails	As informações sobre o recurso que serão avaliadas.
CheckRestrictionsResult	O resultado de uma avaliação de restrições de política de marcar em um recurso.
ContentEvaluationResult	Resultados da avaliação do conteúdo do recurso parcial fornecido.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
ExpressionEvaluationDetails	Detalhes de avaliação de expressões de linguagem de política.
FieldRestriction	As restrições em um campo imposto por uma política específica.
FieldRestrictionResult	O tipo de restrição que é imposto ao campo.
FieldRestrictions	As restrições que serão colocadas em um campo no recurso por política.
IfNotExistsEvaluationDetails	Detalhes de avaliação do efeito IfNotExists.
ManagementGroupsNamespaceType	O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido.
PendingField	Um campo que deve ser avaliado em relação a Azure Policy para determinar restrições.
PolicyEffectDetails	Os detalhes do efeito que foi aplicado ao recurso.
PolicyEvaluationResult	O resultado de uma avaliação de política sem conformidade em relação ao conteúdo do recurso especificado.
PolicyReference	Identificadores de recursos para uma política.
TypedErrorInfo	Detalhes de erro específicos do cenário.

CheckManagementGroupRestrictionsRequest

O marcar parâmetros de restrições de política que descrevem o recurso que está sendo avaliado.

Nome	Tipo	Description
pendingFields	PendingField[]	A lista de campos e valores que devem ser avaliados quanto a possíveis restrições.
resourceDetails	CheckRestrictionsResourceDetails	As informações sobre o recurso que serão avaliadas.

CheckRestrictionEvaluationDetails

Detalhes da avaliação da política.

Nome	Tipo	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Detalhes das expressões avaliadas.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Detalhes de avaliação do efeito IfNotExists.
reason	string	O motivo do resultado da avaliação.

CheckRestrictionsResourceDetails

As informações sobre o recurso que serão avaliadas.

Nome	Tipo	Description
apiVersion	string	A api-version do conteúdo do recurso.
resourceContent	object	O conteúdo do recurso. Isso deve incluir todas as propriedades já conhecidas e pode ser um conjunto parcial de todas as propriedades de recurso.
scope	string	O escopo em que o recurso está sendo criado. Por exemplo, se o recurso for um recurso filho, essa será a ID do recurso pai.

CheckRestrictionsResult

O resultado de uma avaliação de restrições de política de marcar em um recurso.

Nome	Tipo	Description
contentEvaluationResult	ContentEvaluationResult	Resultados da avaliação do conteúdo do recurso parcial fornecido.
fieldRestrictions	FieldRestrictions[]	As restrições que serão colocadas em vários campos no recurso por política.

ContentEvaluationResult

Resultados da avaliação do conteúdo do recurso parcial fornecido.

Nome	Tipo	Description
policyEvaluations	PolicyEvaluationResult[]	Resultados da avaliação de política em relação ao conteúdo do recurso especificado. Isso indicará se o conteúdo parcial fornecido será negado no modo em que se encontra.

ErrorDefinition

Definição de erro.

Nome	Tipo	Description
additionalInfo	TypedErrorInfo[]	Detalhes de erro específicos do cenário adicional.
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes do erro interno.
message	string	Descrição do erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

ExpressionEvaluationDetails

Detalhes de avaliação de expressões de linguagem de política.

Nome	Tipo	Description
expression	string	Expressão avaliada.
expressionKind	string	O tipo de expressão que foi avaliada.
expressionValue	object	Valor da expressão.
operator	string	Operador para comparar o valor da expressão e o valor de destino.
path	string	Caminho da propriedade se a expressão for um campo ou um alias.
result	string	Resultado da avaliação.
targetValue	object	Valor de destino a ser comparado com o valor da expressão.

FieldRestriction

As restrições em um campo imposto por uma política específica.

Nome	Tipo	Description
defaultValue	string	O valor que a política definirá para o campo se o usuário não fornecer um valor.
policy	PolicyReference	Os detalhes da política que está causando a restrição de campo.
policyEffect	string	O efeito da política que está causando a restrição de campo. http://aka.ms/policyeffects
reason	string	O motivo da restrição.
result	FieldRestrictionResult	O tipo de restrição que é imposto ao campo.
values	string[]	Os valores que a política requer ou nega para o campo.

FieldRestrictionResult

O tipo de restrição que é imposto ao campo.

Nome	Tipo	Description
Audit	string	O campo e/ou os valores serão auditados pela política.
Deny	string	Os valores e/ou campo serão negados pela política.
Removed	string	O campo será removido pela política.
Required	string	O campo e/ou os valores são exigidos pela política.

FieldRestrictions

As restrições que serão colocadas em um campo no recurso por política.

Nome	Tipo	Description
field	string	O nome do campo. Pode ser uma propriedade de nível superior, como 'name' ou 'type' ou um alias de campo Azure Policy.
restrictions	FieldRestriction[]	As restrições colocadas nesse campo por política.

IfNotExistsEvaluationDetails

Detalhes de avaliação do efeito IfNotExists.

Nome	Tipo	Description
resourceId	string	ID do último recurso avaliado para efeito IfNotExists.
totalResources	integer	Número total de recursos aos quais a condição de existência é aplicável.

ManagementGroupsNamespaceType

O namespace para o RP de Gerenciamento da Microsoft; somente "Microsoft.Management" é permitido.

Nome	Tipo	Description
Microsoft.Management	string

PendingField

Um campo que deve ser avaliado em relação a Azure Policy para determinar restrições.

Nome	Tipo	Description
field	string	O nome do campo. Pode ser uma propriedade de nível superior, como 'name' ou 'type' ou um alias de campo Azure Policy.
values	string[]	A lista de valores potenciais para o campo que deve ser avaliada em relação a Azure Policy.

PolicyEffectDetails

Os detalhes do efeito que foi aplicado ao recurso.

Nome	Tipo	Description
policyEffect	string	O efeito que foi aplicado ao recurso. http://aka.ms/policyeffects

PolicyEvaluationResult

O resultado de uma avaliação de política sem conformidade em relação ao conteúdo do recurso especificado.

Nome	Tipo	Description
effectDetails	PolicyEffectDetails	Os detalhes do efeito que foi aplicado ao recurso.
evaluationDetails	CheckRestrictionEvaluationDetails	Os resultados detalhados das expressões de política e dos valores que foram avaliados.
evaluationResult	string	O resultado da avaliação da política em relação ao recurso. Normalmente, isso será "NonCompliant", mas poderá conter outros valores se erros forem encontrados.
policyInfo	PolicyReference	Os detalhes da política que foi avaliada.

PolicyReference

Identificadores de recursos para uma política.

Nome	Tipo	Description
policyAssignmentId	string	O identificador de recurso da atribuição de política.
policyDefinitionId	string	O identificador de recurso da definição de política.
policyDefinitionReferenceId	string	O identificador de referência de uma definição de política específica dentro de uma definição de conjunto de políticas.
policySetDefinitionId	string	O identificador de recurso da definição do conjunto de políticas.

TypedErrorInfo

Detalhes de erro específicos do cenário.

Nome	Tipo	Description
info		Os detalhes de erro específicos do cenário.
type	string	O tipo de detalhes de erro incluídos.

Compartilhar via