Policy Definitions - List By Management Group
Obter definições de política num grupo de gestão
Esta operação obtém uma lista de todas as definições de política num determinado grupo de gestão que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de política 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 política 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 política 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 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
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 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 for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de política que estejam no âmbito especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política 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 política 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 política. |
|
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 definitions by management group
Sample Request
Sample Response
{
"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
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 . |
Policy |
A definição de política. |
Policy |
Lista de definições de política. |
policy |
O tipo de definição de política. 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 |
PolicyDefinition
A definição de política.
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
id |
string |
O 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 a apresentar da definição de política. |
|
properties.metadata |
object |
Os metadados de definição de política. Os metadados são um objeto final aberto e, normalmente, são uma coleção de pares de valores 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,
Parameter |
As definições de parâmetros para parâmetros utilizados na regra de política. As chaves são os nomes dos parâmetros. |
|
properties.policyRule |
object |
A regra de política. |
|
properties.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 esta definição de política. |
|
systemData |
Os metadados do sistema relacionados com este recurso. |
||
type |
string |
O tipo de recurso (Microsoft.Authorization/policyDefinitions). |
PolicyDefinitionListResult
Lista de definições de política.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
O URL a utilizar para obter o próximo conjunto de resultados. |
value |
Uma matriz 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.
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. |