Utilizar a extensão do Azure Policy para o Visual Studio Code

Aplica-se à extensão do Azure Policy versão 0.1.2 e mais recente

Saiba como usar a extensão de Política do Azure para Visual Studio Code (VS Code) para pesquisar aliases, revisar recursos e definições de política, exportar objetos e avaliar definições de política. Primeiro, descreveremos como instalar a extensão de Política do Azure no Visual Studio Code. Em seguida, explicaremos como procurar aliases.

A extensão de Política do Azure para Visual Studio Code pode ser instalada no Linux, macOS e Windows.

Pré-requisitos

Os seguintes itens são necessários para concluir as etapas neste artigo:

• Uma subscrição do Azure. Se não tiver uma subscrição do Azure, crie uma conta gratuita antes de começar.
• Visual Studio Code.

Instalar e configurar a extensão da Política do Azure

Depois de atender aos pré-requisitos, você pode instalar a extensão de Política do Azure para Visual Studio Code seguindo estas etapas:

1. Abra o Visual Studio Code.
2. Na barra de menus, vá para Exibir>Extensões.
3. Na caixa de pesquisa, insira Política do Azure.
4. Selecione Política do Azure nos resultados da pesquisa e, em seguida, selecione Instalar.
5. Selecione Recarregar quando necessário.

Para um usuário de nuvem nacional, siga estas etapas para definir o ambiente do Azure primeiro:

1. Selecione Configurações de preferências>de arquivo.>

2. Pesquisar na seguinte cadeia de caracteres: Azure: Cloud

3. Selecione a nuvem de nação na lista:

   

Usando a extensão Policy

Nota

As alterações feitas localmente nas definições de política exibidas na extensão de Política do Azure para Visual Studio Code não são sincronizadas com o Azure.

Ligar a uma conta do Azure

Para avaliar recursos e aliases de pesquisa, você deve se conectar à sua conta do Azure. Siga estas etapas para se conectar ao Azure a partir do Visual Studio Code:

1. Entre no Azure a partir da extensão de Política do Azure ou da Paleta de Comandos.

   • Extensão da Política do Azure

     Na extensão de Política do Azure, selecione Entrar no Azure.

     

   • Paleta de comandos

     Na barra de menus, vá para Exibir>Paleta de Comandos e digite Azure: Entrar.

     

2. Siga as instruções de início de sessão para iniciar sessão no Azure. Depois que você estiver conectado, o nome da sua conta do Azure será mostrado na barra de status na parte inferior da janela Código do Visual Studio.

Selecionar subscrições

Quando inicia sessão pela primeira vez, apenas os recursos de subscrição predefinidos e as definições de política são carregados pela extensão de Política do Azure. Para adicionar ou remover assinaturas da exibição de recursos e definições de política, siga estas etapas:

1. Inicie o comando de subscrição a partir da Paleta de Comandos ou do rodapé da janela.

   • Paleta de comandos

     Na barra de menus, vá para Exibir>Paleta de Comandos e digite Azure: Selecione Assinaturas.

   • Rodapé da janela

     No rodapé da janela na parte inferior da tela, selecione o segmento que corresponde ao Azure: <sua conta>.

2. Use a caixa de filtro para localizar rapidamente assinaturas por nome. Em seguida, verifique ou remova a verificação de cada assinatura para definir as assinaturas mostradas pela extensão do Azure Policy. Quando terminar de adicionar ou remover assinaturas para exibição, selecione OK.

Pesquisar e visualizar recursos

A extensão de Política do Azure lista recursos nas assinaturas selecionadas por Provedor de Recursos e por grupo de recursos no painel Recursos . A vista em árvore inclui os seguintes agrupamentos de recursos na subscrição selecionada ou ao nível da subscrição:

• Fornecedores de Recursos
  • Cada Provedor de Recursos registrado com recursos e recursos filhos relacionados que têm aliases de política
• Grupos de Recursos
  • Todos os recursos do grupo de recursos em que estão

Por padrão, a extensão filtra a parte 'Provedor de Recursos' por recursos existentes e recursos que têm aliases de política. Altere esse comportamento em Configurações>Extensões>Política do Azure para ver todos os Provedores de Recursos sem filtragem.

Clientes com centenas ou milhares de recursos em uma única assinatura podem preferir uma maneira pesquisável de localizar seus recursos. A extensão da Política do Azure possibilita a pesquisa de um recurso específico com as seguintes etapas:

1. Inicie a interface de pesquisa a partir da extensão de Política do Azure ou da Paleta de Comandos.

   • Extensão da Política do Azure

     Na extensão Política do Azure, passe o mouse sobre o painel Recursos e selecione as reticências e, em seguida, selecione Recursos de Pesquisa.

   • Paleta de comandos

     Na barra de menus, vá para Exibir>Paleta de Comandos e insira Política do Azure: Recursos de Pesquisa.

2. Se mais de uma assinatura estiver selecionada para exibição, use o filtro para selecionar qual assinatura pesquisar.

3. Use o filtro para selecionar qual grupo de recursos pesquisar que faz parte da assinatura escolhida anteriormente.

4. Use o filtro para selecionar qual recurso exibir. O filtro funciona para o nome e o tipo de recurso.

Descobrir aliases para propriedades de recursos

Quando um recurso é selecionado, seja por meio da interface de pesquisa ou selecionando-o no modo de exibição em árvore, a extensão de Política do Azure abre o arquivo JSON (JavaScript Object Notation) que representa esse recurso e todos os seus valores de propriedade do Azure Resource Manager.

Quando um recurso é aberto, passar o mouse sobre o nome ou valor da propriedade do Gerenciador de Recursos exibe o alias da Política do Azure, se existir. Neste exemplo, o recurso é um tipo de Microsoft.Compute/virtualMachines recurso e a propriedade properties.storageProfile.imageReference.offer é pairada. Passar o mouse mostra os aliases correspondentes.

Nota

A extensão VS Code suporta apenas a avaliação das propriedades do modo Resource Manager. Para obter mais informações sobre os modos, consulte as definições de modo.

Pesquisar e exibir definições e atribuições de política

A extensão de Política do Azure lista tipos de política e atribuições de política como um modo de exibição de árvore para as assinaturas selecionadas para serem exibidas no painel Políticas . Os clientes com centenas ou milhares de definições ou atribuições de política em uma única assinatura podem preferir uma maneira pesquisável de localizar suas definições ou atribuições de política. A extensão de Política do Azure torna possível pesquisar uma política ou atribuição específica com as seguintes etapas:

1. Inicie a interface de pesquisa a partir da extensão de Política do Azure ou da Paleta de Comandos.

   • Extensão da Política do Azure

     Na extensão Política do Azure, passe o mouse sobre o painel Políticas e selecione as reticências e, em seguida, selecione Políticas de Pesquisa.

   • Paleta de comandos

     Na barra de menus, vá para Exibir>Paleta de Comandos e insira Política do Azure: Políticas de Pesquisa.

2. Se mais de uma assinatura estiver selecionada para exibição, use o filtro para selecionar qual assinatura pesquisar.

3. Use o filtro para selecionar qual tipo de política ou atribuição pesquisar que faz parte da assinatura escolhida anteriormente.

4. Use o filtro para selecionar qual política ou exibir. O filtro funciona para displayName para a definição de política ou atribuição de política.

Ao selecionar uma política ou atribuição, seja por meio da interface de pesquisa ou selecionando-a no modo de exibição em árvore, a extensão de Política do Azure abre o JSON que representa a política ou atribuição e todos os seus valores de propriedade do Gerenciador de Recursos. A extensão pode validar o esquema JSON da Política do Azure aberto.

Exportar objetos

Os objetos de suas assinaturas podem ser exportados para um arquivo JSON local. No painel Recursos ou Políticas, passe o mouse sobre ou selecione um objeto exportável. No final da linha realçada, selecione o ícone Salvar e selecione uma pasta para salvar esse JSON de recursos.

Os seguintes objetos podem ser exportados localmente:

• Painel Recursos
  • Grupos de recursos
  • Recursos individuais (em um grupo de recursos ou em um Provedor de Recursos)
• Painel Políticas
  • Atribuições de políticas
  • Definições de política incorporadas
  • Definições de política personalizadas
  • Iniciativas

On-demand evaluation scan (Análise de avaliação a pedido)

Uma verificação de avaliação pode ser iniciada com a extensão de Política do Azure para Visual Studio Code. Para iniciar uma avaliação, selecione e fixe cada um dos seguintes objetos: um recurso, uma definição de política e uma atribuição de política.

1. Para fixar cada objeto, localize-o no painel Recursos ou no painel Políticas e selecione o pino em um ícone de guia de edição. Fixar um objeto adiciona-o ao painel Avaliação da extensão.
2. No painel Avaliação, selecione um de cada objeto e use o ícone selecionar para avaliação para marcá-lo como incluído na avaliação.
3. Na parte superior do painel Avaliação , selecione o ícone Executar avaliação. Um novo painel no Visual Studio Code é aberto com os detalhes de avaliação resultantes no formulário JSON.

Nota

Para definições de política AuditIfNotExists ou DeployIfNotExists, use o ícone de adição no painel Avaliação ou Política do Azure: Selecione um recurso para verificação de existência (usado apenas para políticas if-not-existis) na Paleta de Comandos para selecionar um recurso relacionado para a verificação de existência.

Os resultados da avaliação fornecem informações sobre a definição e atribuição de políticas, juntamente com a propriedade policyEvaluations.evaluationResult . A saída é semelhante ao exemplo a seguir:

{
    "policyEvaluations": [
        {
            "policyInfo": {
                ...
            },
            "evaluationResult": "Compliant",
            "effectDetails": {
                "policyEffect": "Audit",
                "existenceScope": "None"
            }
        }
    ]
}

Nota

A extensão VS Code suporta apenas a avaliação das propriedades do modo Resource Manager. Para obter mais informações sobre os modos, consulte as definições de modo.

O recurso de avaliação não funciona em instalações macOS e Linux da extensão.

Criar definição de política a partir de um modelo de restrição ou modelo de mutação

A extensão VS Code pode criar uma definição de política a partir de um modelo de restrição GateKeeper v3 do Open Policy Agent (OPA) existente ou de um modelo de mutação existente. O arquivo YAML Ain't Markup Language (YAML) deve estar aberto no VS Code para que a Paleta de Comandos seja uma opção.

1. Abra um arquivo YAML de modelo de restrição OPA GateKeeper v3 válido.

2. Na barra de menus, vá para Exibir>Paleta de Comandos e insira Política do Azure para Kubernetes: Criar Definição de Política a partir de Modelo de Restrição ou Mutação.

3. Selecione o valor sourceType apropriado.

4. Preencha as /* EDIT HERE */ partes da definição de política JSON.

Embora a extensão gere o JSON de uma definição de política, ela não cria a definição no Azure. Depois de preencher os campos apropriados "editar aqui", use o JSON de definição de política concluído e o portal do Azure ou SDK suportado para criar a definição de política em seu ambiente do Azure.

Terminar Sessão

Na barra de menus, vá para Exibir>Paleta de Comandos e digite Azure: Sair.

Próximos passos

• Analise exemplos em Exemplos de Política do Azure.
• Estude a estrutura de definição da Política do Azure.
• Leia Noções básicas sobre os efeitos da política.
• Entenda como criar definições de política de forma programática.
• Saiba como corrigir recursos não compatíveis.
• Entenda o que é um grupo de gerenciamento com Organize seus recursos com grupos de gerenciamento do Azure.