Policy Set Definition Versions - List

Referência

Service:: Policy

API Version:: 2023-04-01

Recupera as versões de definição do conjunto de políticas para uma determinada definição de conjunto de políticas em uma assinatura.
Essa operação recupera uma lista de todas as versões de definição do conjunto de políticas para a definição de conjunto de políticas fornecida.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions?api-version=2023-04-01&$top={$top}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policySetDefinitionName	path	True	string	O nome da definição do conjunto de políticas. Regex pattern: `^[^<>%&:\?.+/][^<>*%&:\?.+/ ]+$`
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.
$top	query		integer int32	Número máximo de registros a serem retornados. Quando o filtro $top não for fornecido, ele retornará 500 registros.

Respostas

Nome	Tipo	Description
200 OK	PolicySetDefinitionVersionListResult	OK – retorna uma matriz de versões de definição do conjunto de políticas.
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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List policy set definitions

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions?api-version=2023-04-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import PolicyClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python list_policy_set_definition_versions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyClient(
        credential=DefaultAzureCredential(),
        policy_definition_name="POLICY_DEFINITION_NAME",
        policy_definition_version="POLICY_DEFINITION_VERSION",
        policy_set_definition_name="CostManagement",
        subscription_id="ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    )

    response = client.policy_set_definition_versions.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2023-04-01/examples/listPolicySetDefinitionVersions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement/versions/1.2.1",
      "type": "Microsoft.Authorization/policySetDefinitions/versions",
      "name": "1.2.1",
      "properties": {
        "displayName": "Cost Management",
        "description": "Policies to enforce low cost storage SKUs",
        "metadata": {
          "category": "Cost Management"
        },
        "version": "1.2.1",
        "policyDefinitions": [
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
            "policyDefinitionReferenceId": "Limit_Skus",
            "parameters": {
              "listOfAllowedSKUs": {
                "value": [
                  "Standard_GRS",
                  "Standard_LRS"
                ]
              }
            }
          },
          {
            "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
            "policyDefinitionReferenceId": "Resource_Naming",
            "parameters": {
              "prefix": {
                "value": "DeptA"
              },
              "suffix": {
                "value": "-LC"
              }
            }
          }
        ]
      }
    }
  ]
}

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 à política.
parameterType	O tipo de dados do parâmetro.
ParameterValuesValue	O valor de um parâmetro.
PolicyDefinitionGroup	O grupo de definição de política.
PolicyDefinitionReference	A referência de definição de política.
PolicySetDefinitionVersion	A versão de definição do conjunto de políticas.
PolicySetDefinitionVersionListResult	Lista de versões de definição do conjunto de políticas.
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

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 para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.)

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

Metadados gerais para o parâmetro .

Nome	Tipo	Description
assignPermissions	boolean	Defina como true para ter portal do Azure criar 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ê queira 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 à 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 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 do Esquema Json.NET 2019-09. Saiba mais sobre como usar esquemas em https://json-schema.org/ e como testar esquemas de rascunho em https://www.jsonschemavalidator.net/.
type	parameterType	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
groupNames	string[]	O nome dos grupos aos quais essa referência de definição de política pertence.
parameters	<string, ParameterValuesValue>	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.