Usare l'estensione Criteri di Azure per Visual Studio Code

Si applica all'estensione Criteri di Azure versione 0.1.2 e successive

Informazioni su come usare l'estensione Criteri di Azure per Visual Studio Code (VS Code) per cercare alias, esaminare le risorse e le definizioni dei criteri, esportare oggetti e valutare le definizioni dei criteri. In primo luogo, verrà descritto come installare l'estensione Criteri di Azure in Visual Studio Code. Verrà quindi illustrato come cercare gli alias.

L'estensione Criteri di Azure per Visual Studio Code può essere installata in Linux, macOS e Windows.

Prerequisiti

Per completare i passaggi in questo articolo, è necessario quanto segue:

Installare e configurare l'estensione Criteri di Azure

Dopo aver soddisfatto i prerequisiti, è possibile installare l'estensione Criteri di Azure per Visual Studio Code seguendo questa procedura:

  1. Aprire Visual Studio Code.
  2. Dalla barra dei menu passare a Visualizza>estensioni.
  3. Nella casella di ricerca immettere Criteri di Azure.
  4. Selezionare Criteri di Azure nei risultati della ricerca e quindi selezionare Installa.
  5. Selezionare Ricarica quando è necessario.

Per un utente del cloud nazionale, seguire questa procedura per impostare prima l'ambiente azure:

  1. Selezionare Preferenze> file>Impostazioni.

  2. Cercare nella stringa seguente: Azure: Cloud

  3. Selezionare il cloud nazionale dall'elenco:

    Screenshot of selecting the nation Azure cloud sign in for Visual Studio Code.

Uso dell'estensione Criteri

Nota

Le modifiche apportate localmente alle definizioni dei criteri visualizzate nell'estensione Criteri di Azure per Visual Studio Code non vengono sincronizzate in Azure.

Connettersi a un account Azure

Per valutare le risorse e gli alias di ricerca, è necessario connettersi all'account Azure. Seguire questa procedura per connettersi ad Azure da Visual Studio Code:

  1. Accedere ad Azure dall'estensione Criteri di Azure o dal riquadro comandi.

    • estensione Criteri di Azure

      Dall'estensione Criteri di Azure selezionare Accedi ad Azure.

      Screenshot of Visual Studio Code and the icon for the Azure Policy extension.

    • Riquadro comandi

      Dalla barra dei menu passare a Visualizza>riquadro comandi e immettere Azure: Accedi.

      Screenshot of the Azure cloud sign in options for Visual Studio Code from the Command Palette.

  2. Seguire le istruzioni di accesso per accedere ad Azure. Dopo la connessione, il nome dell'account Azure viene visualizzato nella barra di stato nella parte inferiore della finestra di Visual Studio Code.

Selezionare le sottoscrizioni

Quando si accede per la prima volta, solo le risorse e le definizioni dei criteri di sottoscrizione predefinite vengono caricate dall'estensione Criteri di Azure. Per aggiungere o rimuovere sottoscrizioni dalla visualizzazione di risorse e definizioni di criteri, seguire questa procedura:

  1. Avviare il comando di sottoscrizione dal riquadro comandi o dal piè di pagina della finestra.

    • Riquadro comandi

      Dalla barra dei menu passare a Visualizza>riquadro comandi e immettere Azure: Selezionare Sottoscrizioni.

    • Piè di pagina della finestra

      Nel piè di pagina della finestra nella parte inferiore della schermata selezionare il segmento corrispondente ad Azure: <l'account>.

  2. Usare la casella di filtro per trovare rapidamente le sottoscrizioni in base al nome. Controllare o rimuovere quindi il controllo da ogni sottoscrizione per impostare le sottoscrizioni visualizzate dall'estensione Criteri di Azure. Al termine dell'aggiunta o della rimozione di sottoscrizioni da visualizzare, selezionare OK.

Cercare e visualizzare le risorse

L'estensione Criteri di Azure elenca le risorse nelle sottoscrizioni selezionate dal provider di risorse e dal gruppo di risorse nel riquadro Risorse. La visualizzazione albero include i seguenti raggruppamenti di risorse all'interno della sottoscrizione selezionata o a livello di sottoscrizione:

  • Provider di risorse
    • Ogni provider di risorse registrato con risorse e risorse figlio correlate con alias dei criteri
  • Gruppi di risorse
    • Tutte le risorse del gruppo di risorse in cui si trovano

Per impostazione predefinita, l'estensione filtra la parte "Provider di risorse" in base alle risorse e alle risorse esistenti con alias dei criteri. Modificare questo comportamento in Impostazioni> Extensions> Criteri di Azure per visualizzare tutti i provider di risorse senza filtrare.

I clienti con centinaia o migliaia di risorse in una singola sottoscrizione possono preferire un modo ricercabile per individuare le risorse. L'estensione Criteri di Azure consente di cercare una risorsa specifica seguendo questa procedura:

  1. Avviare l'interfaccia di ricerca dall'estensione Criteri di Azure o dal riquadro comandi.

    • estensione Criteri di Azure

      Nell'estensione Criteri di Azure passare il puntatore del mouse sul pannello Risorse e selezionare i puntini di sospensione, quindi selezionare Cerca risorse.

    • Riquadro comandi

      Dalla barra dei menu passare a Visualizza>riquadro comandi e immettere Criteri di Azure: Cerca risorse.

  2. Se per la visualizzazione sono selezionate più sottoscrizioni, usare il filtro per selezionare la sottoscrizione da cercare.

  3. Usare il filtro per selezionare il gruppo di risorse in cui eseguire la ricerca che fa parte della sottoscrizione scelta in precedenza.

  4. Usare il filtro per selezionare la risorsa da visualizzare. Il filtro funziona sia per il nome della risorsa che per il tipo di risorsa.

Individuare gli alias per le proprietà delle risorse

Quando viene selezionata una risorsa, sia tramite l'interfaccia di ricerca che selezionandola nella visualizzazione albero, l'estensione Criteri di Azure apre il file JSON (JavaScript Object Notation) che rappresenta tale risorsa e tutti i relativi valori delle proprietà di Azure Resource Manager.

Quando una risorsa è aperta, passare il puntatore del mouse sul nome o sul valore della proprietà di Resource Manager visualizza l'alias Criteri di Azure, se presente. In questo esempio la risorsa è un Microsoft.Compute/virtualMachines tipo di risorsa e la proprietà properties.storageProfile.imageReference.offer viene spostata al passaggio del mouse. Il passaggio del mouse mostra gli alias corrispondenti.

Screenshot of the Azure Policy extension for Visual Studio Code hovering a property to display the alias names.

Nota

L'estensione VS Code supporta solo la valutazione delle proprietà della modalità Resource Manager. Per altre informazioni sulle modalità, vedere le definizioni di modalità.

Cercare e visualizzare definizioni e assegnazioni dei criteri

L'estensione Criteri di Azure elenca i tipi di criteri e le assegnazioni di criteri come visualizzazione albero per le sottoscrizioni selezionate da visualizzare nel riquadro Criteri. I clienti con centinaia o migliaia di definizioni o assegnazioni di criteri in una singola sottoscrizione possono preferire un modo ricercabile per individuare le definizioni o le assegnazioni dei criteri. L'estensione Criteri di Azure consente di cercare criteri o assegnazioni specifici seguendo questa procedura:

  1. Avviare l'interfaccia di ricerca dall'estensione Criteri di Azure o dal riquadro comandi.

    • estensione Criteri di Azure

      Nell'estensione Criteri di Azure passare il puntatore del mouse sul pannello Criteri e selezionare i puntini di sospensione, quindi selezionare Criteri di ricerca.

    • Riquadro comandi

      Dalla barra dei menu passare a Visualizza>riquadro comandi e immettere Criteri di Azure: Criteri di ricerca.

  2. Se per la visualizzazione sono selezionate più sottoscrizioni, usare il filtro per selezionare la sottoscrizione da cercare.

  3. Usare il filtro per selezionare il tipo di criterio o l'assegnazione da cercare che fa parte della sottoscrizione scelta in precedenza.

  4. Usare il filtro per selezionare i criteri o da visualizzare. Il filtro funziona per displayName per la definizione o l'assegnazione di criteri.

Quando si seleziona un criterio o un'assegnazione, tramite l'interfaccia di ricerca o selezionandolo nella visualizzazione albero, l'estensione Criteri di Azure apre il codice JSON che rappresenta i criteri o l'assegnazione e tutti i relativi valori delle proprietà di Resource Manager. L'estensione può convalidare lo schema JSON aperto Criteri di Azure.

Esportare oggetti

Gli oggetti delle sottoscrizioni possono essere esportati in un file JSON locale. Nel riquadro Risorse o criteri passare il puntatore del mouse o selezionare un oggetto esportabile. Alla fine della riga evidenziata selezionare l'icona salva e selezionare una cartella per salvare le risorse JSON.

Gli oggetti seguenti possono essere esportati localmente:

  • Riquadro Risorse
    • Gruppi di risorse
    • Singole risorse (in un gruppo di risorse o in un provider di risorse)
  • Riquadro Criteri
    • Assegnazioni di criteri
    • Definizioni di criteri predefiniti
    • Definizioni di criteri personalizzati
    • Iniziative

Analisi di valutazione su richiesta

È possibile avviare un'analisi di valutazione con l'estensione Criteri di Azure per Visual Studio Code. Per avviare una valutazione, selezionare e aggiungere ognuno degli oggetti seguenti: una risorsa, una definizione di criteri e un'assegnazione di criteri.

  1. Per aggiungere ogni oggetto, trovarlo nel riquadro Risorse o nel riquadro Criteri e selezionare l'icona aggiungi a una scheda di modifica. L'aggiunta di un oggetto viene aggiunta al riquadro Valutazione dell'estensione.
  2. Nel riquadro Valutazione selezionare uno di ogni oggetto e usare l'icona selezionata per la valutazione per contrassegnarla come inclusa nella valutazione.
  3. Nella parte superiore del riquadro Valutazione selezionare l'icona Esegui valutazione. Viene aperto un nuovo riquadro in Visual Studio Code con i dettagli di valutazione risultanti in formato JSON.

Nota

Per le definizioni dei criteri AuditIfNotExists o DeployIfNotExists, usare l'icona con il segno più nel riquadro Valutazione o Criteri di Azure: selezionare una risorsa per verifica dell'esistenza (usata solo per i criteri if-not-exists) dal riquadro comandi per selezionare una risorsa correlata per il controllo dell'esistenza.

I risultati della valutazione forniscono informazioni sulla definizione dei criteri e sull'assegnazione dei criteri insieme alla proprietà policyEvaluations.evaluationResult . L'output è simile al seguente esempio:

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

Nota

L'estensione VS Code supporta solo la valutazione delle proprietà della modalità Resource Manager. Per altre informazioni sulle modalità, vedere le definizioni di modalità.

La funzionalità di valutazione non funziona nelle installazioni macOS e Linux dell'estensione.

Creare una definizione di criteri da un modello di vincolo o da un modello di mutazione

L'estensione VS Code può creare una definizione di criteri da un modello di vincolo Open Policy Agent (OPA) GateKeeper v3 esistente o da un modello di mutazione esistente. Il file YAML Ain't Markup Language (YAML) deve essere aperto in VS Code affinché il riquadro comandi sia un'opzione.

  1. Aprire un file YAML del modello di vincolo OPA GateKeeper v3 valido.

  2. Dalla barra dei menu passare a Visualizza>riquadro comandi e immettere Criteri di Azure per Kubernetes: Crea definizione di criteri dal modello di vincolo o mutazione.

  3. Selezionare il valore sourceType appropriato.

  4. Compilare le /* EDIT HERE */ parti della definizione di criteri JSON.

Mentre l'estensione genera il codice JSON di una definizione di criteri, non crea la definizione in Azure. Dopo aver compilato i campi appropriati "modifica qui", usare il codice JSON di definizione dei criteri completato e il portale di Azure o l'SDK supportato per creare la definizione dei criteri all'interno dell'ambiente Azure.

Disconnettersi

Dalla barra dei menu passare a Visualizza>riquadro comandi e quindi immettere Azure: Disconnetti.

Passaggi successivi