Policy Set Definitions - List By Management Group
Recupera todas as definições do conjunto de políticas no grupo de gerenciamento.
Essa operação recupera uma lista de todas as definições do conjunto de políticas em um determinado grupo de gerenciamento que correspondem ao $filter opcional determinado. 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 conjunto de políticas 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 conjunto de políticas 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 conjunto de políticas cujo tipo corresponde ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas cuja categoria corresponde ao {value}.
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions?api-version=2023-04-01&$filter={$filter}&$expand={$expand}&$top={$top}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
management
|
path | True |
string |
A ID do grupo de gerenciamento. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
$expand
|
query |
string |
Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta. Os valores com suporte são 'LatestDefinitionVersion, EffectiveDefinitionVersion'. |
|
$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 conjunto de políticas que estão no escopo especificado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de conjunto de políticas 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 conjunto de políticas cuja categoria corresponde ao {value}. |
|
$top
|
query |
integer int32 |
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 |
OK - Retorna uma matriz de definições de conjunto de políticas. |
|
Other Status Codes |
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 set definitions at management group level
Solicitação de exemplo
Resposta de exemplo
{
"value": [
{
"properties": {
"displayName": "[Preview]: Enable Monitoring in Azure Security Center",
"policyType": "BuiltIn",
"description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.",
"metadata": {
"category": "Security Center"
},
"version": "1.2.1",
"versions": [
"1.2.1",
"1.0.0"
],
"parameters": {},
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId1"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId2"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId3"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId4"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
"policyDefinitionReferenceId": "RefId5"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId6"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId7"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
"policyDefinitionReferenceId": "RefId8"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId9"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "RefId10"
}
]
},
"id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
"type": "Microsoft.Authorization/policySetDefinitions",
"name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8"
},
{
"id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/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"
],
"policyDefinitions": [
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Limit_Skus",
"parameters": {
"listOfAllowedSKUs": {
"value": [
"Standard_GRS",
"Standard_LRS"
]
}
}
},
{
"policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
"definitionVersion": "1.*.*",
"policyDefinitionReferenceId": "Resource_Naming",
"parameters": {
"prefix": {
"value": "DeptA"
},
"suffix": {
"value": "-LC"
}
}
}
]
}
}
]
}
Definições
Nome | Description |
---|---|
Cloud |
Uma resposta de erro de uma operação de política. |
created |
O tipo de identidade que criou o recurso. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Resposta de erro |
Metadata |
Metadados gerais para o parâmetro. |
Parameter |
A definição de um parâmetro que pode ser fornecido para a política. |
parameter |
O tipo de dados do parâmetro. |
Parameter |
O valor de um parâmetro. |
Policy |
O grupo de definição de política. |
Policy |
A referência de definição de política. |
Policy |
A definição do conjunto de políticas. |
Policy |
Lista de definições de conjunto de políticas. |
policy |
O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. |
system |
Metadados relativos à criação e última modificação do recurso. |
CloudError
Uma resposta de erro de uma operação de política.
Nome | Tipo | Description |
---|---|---|
error |
Resposta de erro |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
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
Resposta de erro
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
Metadata
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
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 |
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 |
O tipo de dados do parâmetro. |
parameterType
O tipo de dados do parâmetro.
Nome | Tipo | Description |
---|---|---|
Array |
string |
|
Boolean |
string |
|
DateTime |
string |
|
Float |
string |
|
Integer |
string |
|
Object |
string |
|
String |
string |
ParameterValuesValue
O valor de um parâmetro.
Nome | Tipo | Description |
---|---|---|
value |
object |
O valor do parâmetro. |
PolicyDefinitionGroup
O grupo de definição de política.
Nome | Tipo | Description |
---|---|---|
additionalMetadataId |
string |
Uma 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 de exibição do grupo. |
name |
string |
O nome do grupo. |
PolicyDefinitionReference
A referência de definição de política.
Nome | Tipo | Description |
---|---|---|
definitionVersion |
string |
A versão da definição de política a ser usada. |
effectiveDefinitionVersion |
string |
A versão efetiva da definição de política em uso. Isso só estará presente se solicitado por meio do parâmetro de consulta $expand. |
groupNames |
string[] |
O nome dos grupos aos quais essa referência de definição de política pertence. |
latestDefinitionVersion |
string |
A versão mais recente da definição de política disponível. Isso só estará presente se solicitado por meio do parâmetro de consulta $expand. |
parameters |
<string,
Parameter |
Os valores de parâmetro para a regra de política referenciada. As chaves são os nomes dos parâmetros. |
policyDefinitionId |
string |
A ID da definição de política ou definição do conjunto de políticas. |
policyDefinitionReferenceId |
string |
Uma ID exclusiva (dentro da definição do conjunto de políticas) para essa referência de definição de política. |
PolicySetDefinition
A definição do conjunto de políticas.
Nome | Tipo | Description |
---|---|---|
id |
string |
A ID da definição do conjunto de políticas. |
name |
string |
O nome da definição do conjunto de políticas. |
properties.description |
string |
A descrição da definição do conjunto de políticas. |
properties.displayName |
string |
O nome de exibição da definição do conjunto de políticas. |
properties.metadata |
object |
Os metadados de definição do conjunto de políticas. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave. |
properties.parameters |
<string,
Parameter |
Os parâmetros de definição do conjunto de políticas que podem ser usados em referências de definição de política. |
properties.policyDefinitionGroups |
Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. |
|
properties.policyDefinitions |
Uma matriz de referências de definição de política. |
|
properties.policyType |
O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static. |
|
properties.version |
string |
A versão de definição do conjunto de políticas no formato #.#.#. |
properties.versions |
string[] |
Uma lista de versões disponíveis para essa definição de conjunto de políticas. |
systemData |
Os metadados do sistema relacionados a esse recurso. |
|
type |
string |
O tipo do recurso (Microsoft.Authorization/policySetDefinitions). |
PolicySetDefinitionListResult
Lista de definições de conjunto de políticas.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
A URL a ser usada para obter o próximo conjunto de resultados. |
value |
Uma matriz de definições de conjunto de políticas. |
policyType
O tipo de definição do conjunto de políticas. Os valores possíveis são NotSpecified, BuiltIn, Custom e Static.
Nome | Tipo | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Metadados relativos à criação e última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |