Skip to content

matoy/AzureProtectedVMCheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AzureProtectedVMCheck

Why this function app ?

Azure provides recovery vaults to protect virtual machines.

This function app automatically checks if virtual machines of a specified subscription are protected or not.

You can also specify exception if you explicitely don't want to check for protection on some virtual servers.

Coupled with a common monitoring system (nagios, centreon, zabbix, or whatever you use), you'll automatically get alerted as soon as a virtual machine is not protected as it should be.


Requirements

  • An "app registration" account (client id, valid secret and tenant id).
  • Backup Reader RBAC role for this account on all subscriptions you want to monitor.


Installation

Once you have all the requirements, you can deploy the Azure function with de "Deploy" button below:

Deploy to Azure alt text


This will deploy an Azure app function with its storage account, app insights and "consumption" app plan. A keyvault will also be deployed to securely store the secret of your app principal.

alt text

Choose you Azure subscription, region and create or select a resource group.

  • App Name:
    You can customize a name for resources that will be created.

  • Tenant ID:
    If your subscription depends on the same tenant than the account used to retrieve subscriptions information, then you can use the default value.
    Otherwise, enter the tenant ID of the account.

  • Subscription Reader Application ID:
    Client ID of the account used to retrieve subscriptions information.

  • Subscription Reader Secret:
    Secret of the account used to retrieve subscriptions information.

  • Zip Release URL:
    For testing, you can leave it like it.
    For more serious use, I would advise you host your own zip file so that you wouldn't be subject to release changes done in this repository.
    See below for more details.

  • Max Concurrent Jobs:
    An API call to Azure will be made for each virtual machine.
    If you have many virtual machines, you might get an http timeout when calling the function from your monitoring system.
    This value allows to make calls to Azure API in parallel.

  • Global Exceptions:
    There are some default virtual machine names that you might not want to check.
    You can specify comma separated names.
    The ARM templates already brings some usefull examples.

  • Signature:
    When this function will be called by your monitoring system, you likely might forget about it.
    The signature output will act a reminder since you'll get it in the results to your monitoring system.


When deployment is done, you can get your Azure function's URL in the output variables.

Trigger it manually in your favorite browser and eventually look at the logs in the function.

After you execute the function for the first time, it might (will) need 5-10 minutes before it works because it has to install Az module. You even might get an HTTP 500 error. Give the function some time to initialize, re-execute it again if necessary and be patient, it will work.

Even after that, you might experience issue if Azure takes time to resolve your newly created keyvault:
alt text
Wait a short time and then restart your Azure function, your should have something like:
alt text


Monitoring integration

From there, you just have to call your function's URL from your monitoring system.

You can find a script example in "monitoring-script-example" folder which makes a GET request, outputs the result, looks for "CRITICAL" or "WARNING" in the text and use the right exit code accordingly.

Calling the function once a day should be enough.

You have make 1 function call per subscription by specifying the subscriptionid in the GET parameters: &subscriptionid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

You can also specify comma separated virtual machine names to exclude with &exclusions=vm1,vm2

Be sure to have an appropriate timeout (30s or more) because if you have many virtual machines, the function might need some time to execute.

This is an example of what you'd get in Centreon:
alt text


How to stop relying on this repository's zip

To make your function to stop relying on this repo's zip and become independant, follow these steps:

  • remove zipReleaseURL app setting and restart app
  • in "App files" section, edit "requirements.psd1" and uncomment the line: 'Az' = '6.*'
  • in "Functions" section, add a new function called "AzureProtectedVMCheck" and paste in it the content of the file release/AzureProtectedVMCheck/run.ps1 in this repository

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published