Azure Resources

Overview

Each of the API commands described here relate to retrieving and updating one or more Azure Resources being monitored at your site. Each Azure Resource is completely described by a Hash.

The Azure Resource Hash

An example JSON-encoded Azure Resource Hash is shown below:

{
    "id":1,                                               # Azure resource ID (Assigned by Uptime Cloud Monitor)
    "azure_account_id":3,                                 # Azure account ID (Assigned by Uptime Cloud Monitor)
    "azure_subscription_id":10,                           # Azure subscription ID (Assigned by Uptime Cloud Monitor)
    "azure_resource_group_id":15,                         # Azure resource group ID (Assigned by Uptime Cloud Monitor)
    "name":"resource_1",                                  # Name of the Azure Resource
    "type":"type_1",                                      # Type of the Azure Resource
    "sku_attrs":{...},                                    # Sku Attributes of the Azure Resource
    "unique_id":"/subscriptions/sub_id/resourceGroups/rg_id/resource_path", # A unique identifier for the resource
    "location":"us-west",                                 # Location of the resource
    "reading_enabled":true,                               # If monitoring is enabled for the resource
    "last_seen_at":null                                   # Timestamp when resource was last seen/monitored
}
Note

Currently UCM supports monitoring for only four azure types : VM, MSSQL, MySQL and PostgreSQL. Corresponding azure types are Microsoft.Compute/virtualMachines, Microsoft.Sql/servers/databases, Microsoft.DBforMySQL/servers & Microsoft.DBforPostgreSQL/servers.

If type of resource is other than this, we report ‘Other’ and even for these four types we return short versions from API (Eg. VM) for readability purpose. For filtering on type, you still need to send actual resource type (Eg. Microsoft.Compute/virtualMachines)

Index

Retrieve a list of all of your Azure Resources for an Azure Resource Group.

Required Parameters:

Azure_Account_ID
ID of Azure Account for which resources are being fetched

Optional Parameters:

Azure_Subscription_ID
ID of Azure Subscription for which resources are being fetched
Azure_Resource_Group_ID
ID of Azure Resource Group for which resources are being fetched
type
Fetch resources of specific type

CURL Command, and variations:

curl -su <APIKEY>:U https://api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/resources.json

curl -s https://<APIKEY>:U@api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/resources.json

You can also query for resources under a specific azure subscription and azure resource group (for all the APIs mentioned below)

curl -s https://<APIKEY>:U@api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/subscriptions/<Azure_Sub_ID>/resource_groups/<Azure_ResGroup_ID>/resources.json
CURL command with optional parameters:
curl -su <APIKEY>:U https://api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/resources.json?type=some_type
Filter azure resources on ‘name’
curl -su <APIKEY>:U https://api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/resources.json?filter_str=some_string

CURL Response:

Response is a JSON-encoded list of Azure Resource Hashes and stats(contains total no of resources for the resource group/account).

{
    "resources":[
        {
            "id":1,
            "azure_account_id":3,
            "azure_subscription_id":10,
            "azure_subscription_unique_id":"aefbdolpr-23ed2342-dsdf23rad",
            "azure_resource_group_name":"test-rg",
            "type":"type_1",
            "sku_attrs":{...},
            "unique_id":"/subscriptions/sub_id/resourceGroups/rg_id/resource_path",
            "location":"us-west",
            "reading_enabled":true,
            "last_seen_at":"2017-08-23T06:41:07-05:00"
        }
    ],
    "stats":{
        "total":1
    }
}

Show

Show one Azure Resource based on ID.

Required Parameters:

Azure_Account_ID
ID of Azure Account for which resource is to be updated
Azure_Resource_ID
ID of Azure Resource to be updated

Optional Parameters:

Azure_Subscription_ID
ID of Azure Subscription for which resource is to be updated
Azure_Resource_Group_ID
ID of Azure Resource Group for which resource is to be updated
Curl Command
curl -s -H "Content-Type: application/json" https://<APIKEY>:U@api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/subscriptions/<Azure_Subscription_ID>/resource_groups/<Azure_Resource_Group_ID>/resources/<Azure_Resource_ID>.json
Curl Response
{
    "id":1,
    "azure_account_id":3,
    "azure_subscription_unique_id":"aefbdolpr-23ed2342-dsdf23rad",
    "azure_resource_group_name":"test-rg",
    "name":"resource_1",
    "type":"type_1",
    "sku_attrs":{...},
    "unique_id":"/subscriptions/sub_id/resourceGroups/rg_id/resource_path",
    "location":"us-west",
    "reading_enabled":false,
    "last_seen_at":null
}

Update

Updates an existing Azure Resource.
  • Only reading_enabled attribute is allowed to be modified for an azure resource.

Required Parameters:

Azure_Account_ID
ID of Azure Account for which resource is to be updated
Azure_Resource_ID
ID of Azure Resource to be updated
reading_enbled
If monitoring is enabled for the resource

Optional Parameters:

Azure_Subscription_ID
ID of Azure Subscription for which resource is to be updated
Azure_Resource_Group_ID
ID of Azure Resource Group for which resource is to be updated
Curl Command
curl -s -XPUT -H "Content-Type: application/json" https://<APIKEY>:U@api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/subscriptions/<Azure_Subscription_ID>/resource_groups/<Azure_Resource_Group_ID>/resources/<Azure_Resource_ID>.json -d '{ "reading_enabled":"false" }'

curl -s -XPUT -H "Content-Type: application/json" https://<APIKEY>:U@api.copperegg.com/v2/azure/accounts/<Azure_Account_ID>/resources/<Azure_Resource_ID>.json -d '{ "reading_enabled":"false" }'
Curl Response
{
    "id":1,
    "azure_account_id":3,
    "azure_subscription_unique_id":"aefbdolpr-23ed2342-dsdf23rad",
    "azure_resource_group_name":"test-rg",
    "name":"resource_1",
    "type":"type_1",
    "sku_attrs":{...},
    "unique_id":"/subscriptions/sub_id/resourceGroups/rg_id/resource_path",
    "location":"us-west",
    "reading_enabled":false,
    "last_seen_at":null
}