Policy Set Definitions - List By Management Group
Obtém todas as definições de conjuntos de políticas no grupo de gestão.
Esta operação obtém uma lista de todas as definições do conjunto de políticas num determinado grupo de gestão que correspondem ao $filter opcional especificado. 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 inclui todas as definições de conjuntos de políticas associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o grupo de gestão especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos de políticas que estejam no grupo de gestão especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn e Custom. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos 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}&$top={$top}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
management
|
path | True |
string |
O ID do grupo de gestão. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
$filter
|
query |
string |
O filtro a aplicar na operação. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos de políticas que estejam no âmbito especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos de políticas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de conjuntos de políticas cuja categoria corresponde ao {value}. |
|
$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 |
OK - Devolve uma matriz de definições de conjuntos de políticas. |
|
Other Status Codes |
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
Sample Request
Sample Response
{
"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",
"policyDefinitionReferenceId": "RefId1"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d",
"policyDefinitionReferenceId": "RefId2"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60",
"policyDefinitionReferenceId": "RefId3"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759",
"policyDefinitionReferenceId": "RefId4"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c",
"policyDefinitionReferenceId": "RefId5"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc",
"policyDefinitionReferenceId": "RefId6"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed",
"policyDefinitionReferenceId": "RefId7"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15",
"policyDefinitionReferenceId": "RefId8"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9",
"policyDefinitionReferenceId": "RefId9"
},
{
"policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d",
"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",
"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 |
---|---|
Cloud |
Uma resposta de erro de uma operação de política. |
created |
O tipo de identidade que criou o recurso. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
Resposta a Erros |
Metadata |
Metadados gerais para o parâmetro . |
Parameter |
A definição de um parâmetro que pode ser fornecido à 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 conjuntos 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.
Name | Tipo | Description |
---|---|---|
error |
Resposta a Erros |
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 |
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 .
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 |
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 |
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,
Parameter |
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. |
PolicySetDefinition
A definição do conjunto de políticas.
Name | Tipo | Description |
---|---|---|
id |
string |
O 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 a apresentar da definição do conjunto de políticas. |
properties.metadata |
object |
Os metadados de definição do conjunto de políticas. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores chave. |
properties.parameters |
<string,
Parameter |
Os parâmetros de definição do conjunto de políticas que podem ser utilizados 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 na 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 esta definição de conjunto de políticas. |
systemData |
Os metadados do sistema relacionados com este recurso. |
|
type |
string |
O tipo de recurso (Microsoft.Authorization/policySetDefinitions). |
PolicySetDefinitionListResult
Lista de definições de conjuntos de políticas.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
O URL a utilizar para obter o próximo conjunto de resultados. |
value |
Uma matriz de definições de conjuntos 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.
Name | Tipo | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
NotSpecified |
string |
|
Static |
string |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | 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. |