traffic_manager.md in fog-azure-rm-0.3.8

- old
+ new

@@ -1,8 +1,8 @@
 # Traffic Manager
 
-This document explains how to get started using Azure Traffic Manager Service with Fog. With this gem you can create/update/list/delete Traffic Manager Profiles and End Points.
+This document explains how to get started using Azure Traffic Manager Service with Fog. With this gem you can create, update, list or delete Traffic Manager Profiles and End Points.
 
 ## Usage
 
 First of all, you need to require the Fog library by executing:
 
@@ -12,149 +12,150 @@
 ## Create Connection
 
 Next, create a connection to the Traffic Manager Service:
 
 ```ruby
-    azure_traffic_manager_service = Fog::TrafficManager::AzureRM.new(
-      tenant_id:        '<Tenantid>',                                                       # Tenant id of Azure Active Directory Application
-      client_id:        '<Clientid>',                                                       # Client id of Azure Active Directory Application
-      client_secret:    '<ClientSecret>',                                                   # Client Secret of Azure Active Directory Application
-      subscription_id:  '<Subscriptionid>',                                                 # Subscription id of an Azure Account
-      environment:      '<AzureCloud/AzureChinaCloud/AzureUSGovernment/AzureGermanCloud>'   # Azure cloud environment. Default is AzureCloud.
+fog_traffic_manager_service = Fog::TrafficManager::AzureRM.new(
+      tenant_id:        '<Tenant Id>',                                                          # Tenant Id of Azure Active Directory Application
+      client_id:        '<Client Id>',                                                          # Client Id of Azure Active Directory Application
+      client_secret:    '<Client Secret>',                                                      # Client Secret of Azure Active Directory Application
+      subscription_id:  '<Subscription Id>',                                                    # Subscription Id of an Azure Account
+      environment:      '<AzureCloud/AzureChinaCloud/AzureUSGovernment/AzureGermanCloud>'       # Azure cloud environment. Default is AzureCloud.
 )
 ```
 
 ## Check Traffic Manager Profile Existence
 
 ```ruby
-azure_traffic_manager_service.traffic_manager_profiles.check_traffic_manager_profile_exists(<Resource Group Name>, <Profile Name>)
+fog_traffic_manager_service.traffic_manager_profiles.check_traffic_manager_profile_exists('<Resource Group Name>', '<Profile Name>')
 ```
 
 ## Create Traffic Manager Profile
 
 Create a new Traffic Manager Profile. The parameter 'traffic_routing_method' can be 'Performance', 'Weighted' or 'Priority'.
 
 ```ruby
-      profile = azure_traffic_manager_service.traffic_manager_profiles.create(
+profile = fog_traffic_manager_service.traffic_manager_profiles.create(
         name: '<Profile Name>',
         resource_group: '<Resource Group Name>',
-        traffic_routing_method: 'Performance',
+        traffic_routing_method: '<Routing Method Name>',
         relative_name: '<Profile Relative Name>',
-        ttl: '30',
-        protocol: 'http',
-        port: '80',
-        path: '/monitorpage.aspx',
-        tags: { key1: "value1", key2: "value2", keyN: "valueN" }                          # [Optional]
-      )
+        ttl: '<TTL>',
+        protocol: '<Protocol Name>',
+        port: '<Port Number>',
+        path: '<Path>',
+        tags: { key1: 'value1', key2: 'value2', keyN: 'valueN' }                          # [Optional]
+)
 ```
 
 ## List Traffic Manager Profiles
 
 List Traffic Manager Profiles in a resource group
 
 ```ruby
-    profiles  = azure_traffic_manager_service.traffic_manager_profiles(resource_group: '<Resource Group name>')
-    profiles.each do |profile|
-      puts "#{profile.name}"
-    end
+profiles  = fog_traffic_manager_service.traffic_manager_profiles(resource_group: '<Resource Group Name>')
+profiles.each do |profile|
+    puts "#{profile.name}"
+end
 ```
 
 ## Retrieve a single Traffic Manager Profile
 
 Get a single record of Traffic Manager Profile
 
 ```ruby
-     profile = azure_traffic_manager_service
-               .traffic_manager_profiles
-                .get('<Resource Group name>', '<Profile name>')
-     puts "#{profile.name}"
+profile = fog_traffic_manager_service
+             .traffic_manager_profiles
+             .get('<Resource Group Name>', '<Profile Name>')
+puts "#{profile.name}"
 ```
 
 ## Update a Traffic Manager Profile
 
 Get a Traffic Manager Profile object from the get method and then update that Traffic Manager Profile. You can update the Traffic Manager Profile by passing the modifiable attributes in the form of a hash.
 
 ```ruby
-    profile.update(
-              traffic_routing_method: 'Weighted',
-              ttl: '35',
-              protocol: 'https',
-              port: '90',
-              path: '/monitorpage1.aspx'
-    )
+profile.update(
+              traffic_routing_method: '<Routing Method Name>',
+              ttl: '<TTL>',
+              protocol: '<Protocol Name>',
+              port: '<Port Number>',
+              path: '<Path>'
+)
 ```
 
 ## Destroy a single Traffic Manager Profile
 
 Get a Traffic Manager Profile object from the get method and then destroy that Traffic Manager Profile.
 
 ```ruby
-     profile.destroy
+profile.destroy
 ```
 
 ## Check Traffic Manager Endpoint Existence
 
 ```ruby
- azure_network_service.traffic_manager_end_points.check_traffic_manager_endpoint_exists(
-   <Resource Group Name>,
-   <Profile Name>,
-   <Endpoint Name>,
-   <Type(externalEndpoints)>
-   )
+azure_network_service.traffic_manager_end_points.check_traffic_manager_endpoint_exists(
+        '<Resource Group Name>',
+        '<Profile Name>',
+        '<Endpoint Name>',
+        '<Type(<Endpoint Type>)>'
+)
 ```
 
 ## Create Traffic Manager Endpoint
 
 Traffic Manager Profile is pre-requisite of Traffic Manager Endpoint. Create a new Traffic Manager Endpoint. The parameter 'type' can be 'externalEndpoints, 'azureEndpoints' or 'nestedEndpoints'.
 
 ```ruby
-      endpoint = azure_network_service.traffic_manager_end_points.create(
+endpoint = azure_network_service.traffic_manager_end_points.create(
         name: '<Endpoint Name>',
         traffic_manager_profile_name: '<Profile Name>',
         resource_group: '<Resource Group Name>',
-        type: 'externalEndpoints',
-        target: 'test.com',
-        endpoint_location: 'West US'
-      )
+        type: '<Endpoint Type>',
+        target: '<Target URL>',
+        endpoint_location: '<Location>'
+)
 ```
 
 ## List Traffic Manager Endpoints
 
 List Traffic Manager Endpoints in a resource group.
 
 ```ruby
-    endpoints  = azure_traffic_manager_service.traffic_manager_end_points(resource_group: '<Resource Group name>', traffic_manager_profile_name: '<Profile Name>')
-    endpoints.each do |endpoint|
-      puts "#{endpoint.name}"
-    end
+endpoints  = fog_traffic_manager_service.traffic_manager_end_points(resource_group: '<Resource Group Name>', traffic_manager_profile_name: '<Profile Name>')
+endpoints.each do |endpoint|
+   puts "#{endpoint.name}"
+end
 ```
 
 ## Retrieve a single Traffic Manager Endpoint
 
 Get a single Traffic Manager Endpoint.
 
 ```ruby
-      endpoint = azure_traffic_manager_service
+endpoint = fog_traffic_manager_service
                  .traffic_manager_end_points
-                 .get('<Resource Group name>', '<Profile Name>', '<Endpoint name>', '<Endpoint type>')
-      puts "#{endpoint.name}"
+                 .get('<Resource Group Name>', '<Profile Name>', '<Endpoint name>', '<Endpoint Type>')
+puts "#{endpoint.name}"
 ```
 ## Update a Traffic Manager Endpoint
 
 Get a Traffic Manager Endpoint object from the get method and then update that Traffic Manager Endpoint. You can update the Traffic Manager Endpoint by passing the modifiable attributes in the form of a hash.
 
 ```ruby
-      endpoint.update(type: 'externalEndpoints',
-                      target: 'test1.com',
-                      endpoint_location: 'Central US')
+endpoint.update(type: '<Endpoint Type>',
+                target: '<Target URL>',
+                endpoint_location: '<Location>'
+)
 ```
 
 ## Destroy a single Traffic Manager Endpoint
 
 Get a Traffic Manager Endpoint object from the get method and then destroy that Traffic Manager Endpoint.
 
 ```ruby
-     endpoint.destroy
+endpoint.destroy
 ```
 
 ## Support and Feedback
 Your feedback is highly appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.