rs_azure_resources

Azure ARM Resource Plugin

Overview

The Azure ARM Resource Plugin integrates RightScale Self-Service with the basic functionality of the Resources resource in the Azure API.

Requirements

• A general understanding CAT development and definitions
  • Refer to the guide documentation for details SS Guides
• The admin, ss_designer & ss_end_user roles, in a RightScale account with SelfService enabled. admin is needed to retrieved the RightScale Credential values identified below.
• Azure Service Principal (AKA Azure Active Directory Application) with the appropriate permissions to manage resources in the target subscription
• The following RightScale Credentials
  • AZURE_APPLICATION_ID
  • AZURE_APPLICATION_KEY
• The following packages are also required (See the Installation section for details):
  • sys_log

Installation

1. Be sure your RightScale account has Self-Service enabled
2. Connect AzureRM Cloud credentials to your RightScale account (if not already completed)
3. Follow steps to Create an Azure Active Directory Application
4. Grant the Azure AD Application access to the necessary subscription(s)
5. Retrieve the Application ID & Authentication Key
6. Create RightScale Credentials with values that match the Application ID (Credential name: AZURE_APPLICATION_ID) & Authentication Key (Credential name: AZURE_APPLICATION_KEY)
7. Retrieve your Tenant ID
8. Update rs_azure_resource.rb Plugin with your Tenant ID.
   • Replace "TENANT_ID" in token_url "https://login.microsoftonline.com/TENANT_ID/oauth2/token" with your Tenant ID
9. Navigate to the appropriate Self-Service portal
   • For more details on using the portal review the SS User Interface Guide
10. In the Design section, use the Upload CAT interface to complete the following:
    1. Upload each of packages listed in the Requirements Section
    2. Upload the rs_azure_resource.rb file located in this repository

How to Use

The ARM Resource Plugin has been packaged as plugins/rs_azure_resource. In order to use this plugin you must import this plugin into a CAT.

import "plugins/rs_azure_resource"

For more information on using packages, please refer to the RightScale online documentation. Importing a Package

Plugin Parameters

subscription_id

There is a "subscription_id" Plugin Parameter in the ARM Template Plugin. Recommended usage (where the default value matches your target Subscription ID):

parameter "subscription_id" do
  like $rs_azure_resource.subscription_id
  default "12345678-1234-1234-1234-123456789012"
end

Note: default is not a required field. You could, instead, elect to populate this parameter at every CloudApp Launch.

Supported Resources

None - This release only supports use of the plugin via RCL.

Supported Fields

N/A

Usage

N/A

Supported Actions

Action	API Implementation	Support Level
update	Create Or Update By Id	Supported
updatebyid	Update By Id	Supported
get	Get By Id	Supported
list	List	Supported
listbyresourcegroup	List By Resource Group	Supported

Examples

Please review arm_resource_test_cat.rb for a basic example implementation.

Known Issues / Limitations

• This plugin only supports working with resources in RCL. It does not support provisioning CAT resources.

License

The Azure ARM Resource Plugin source code is subject to the MIT license, see the LICENSE file.