fog-azure-rm 0.1.1 → 0.1.2

data/lib/fog/azurerm/docs/resources.md

@@ -1,155 +1,155 @@
-#Resources
-
-This document explains how to get started using Azure Resources Service with Fog. With this gem you can create/update/list/delete resource groups.
-
-## Usage
-
-First of all, you need to require the Fog library by executing:
-
-```ruby
-require 'fog/azurerm'
-```
-
-## Create Connection
-
-Next, create a connection to the Resources Service:
-
-```ruby
-    azure_resources_service = Fog::Resources::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
-)
-```
-## Create Resource Group
-
-Create a new resource group
-
-```ruby
-    azure_resources_service.resource_groups.create(
-        name:     '<Resource Group name>',
-        location: 'West US'
- )
-```
-## List Resource Groups
-
-```ruby
-    azure_resources_service.resource_groups.each do |resource_group|
-        puts "#{resource_group.name}"
-        puts "#{resource_group.location}"
-    end
-```
-
-## Retrieve a single Resource Group
-
-Get a single record of Resource Group
-
-```ruby
-      resource_group = azure_resources_service
-                          .resource_groups
-                          .get('<Resource Group name>')
-      puts "#{resource_group.name}"
-```
-
-## Destroy a single Resource Group
-
-Get resource group object from the get method(described above) and then destroy that resource group.
-
-```ruby
-      resource_group.destroy
-```
-## Tagging a Resource
-
-You can tag a Resource as following:
-
-```ruby
-    azure_resources_service.tag_resource(
-        '<Resource-ID>',
-        '<Tag-Key>',
-        '<Tag-Value>'
-    )
-```
-
-## List Tagged Resources in a Subscription
-
-```ruby
-    azure_resources_service.azure_resources(tag_name: '<Tag-Key>', tag_value: '<Tag-Value>').each do |resource|
-        puts "#{resource.name}"
-        puts "#{resource.location}"
-        puts "#{resource.type}"        
-    end
-```
-OR
-```ruby
-    azure_resources_service.azure_resources(tag_name: '<Tag-Key>').each do |resource|
-        puts "#{resource.name}"
-        puts "#{resource.location}"
-        puts "#{resource.type}"        
-    end
-```
-## Retrieve a single Resource
-
-Get a single record of Tagged Resources
-
-```ruby
-    resource = azure_resources_service
-                          .azure_resources(tag_name: '<Tag-Key>')
-                          .get('<Resource-ID>')
-    puts "#{resource.name}"
-```
-## Remove tag from a Resource
-
-Remove tag from a resource as following:
-
-```ruby
-    azure_resources_service.delete_resource_tag(
-        '<Resource-ID>',
-        '<Tag-Key>',
-        '<Tag-Value>'
-        )
-```
-
-## Create Deployment
-
-Create a Deployment
-
-```ruby
-    azure_resources_service.deployments.create(
-        name:            '<Deployment name>',
-        resource_group:  '<Resource Group name>',
-        template_link:   '<Template Link>',
-        parameters_link: '<Parameters Link>'
- )
-```
-## List Deployments
-
-List Deployments in a resource group
-
-```ruby
-    azure_resources_service.deployments(resource_group: '<Resource Group Name>').each do |deployment|
-        puts "#{deployment.name}"
-    end
-```
-
-## Retrieve a single Deployment
-
-Get a single record of Deployment
-
-```ruby
-      deployment = azure_resources_service
-                          .deployments
-                          .get('<Resource Group name>', '<Deployment name>')
-      puts "#{deployment.name}"
-```
-
-## Destroy a single Deployment
-
-Get Deployment object from the get method(described above) and then destroy that Deployment.
-
-```ruby
-      deployment.destroy
-```
-
-## Support and Feedback
-Your feedback is appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.
+#Resources
+
+This document explains how to get started using Azure Resources Service with Fog. With this gem you can create/update/list/delete resource groups.
+
+## Usage
+
+First of all, you need to require the Fog library by executing:
+
+```ruby
+require 'fog/azurerm'
+```
+
+## Create Connection
+
+Next, create a connection to the Resources Service:
+
+```ruby
+    azure_resources_service = Fog::Resources::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
+)
+```
+## Create Resource Group
+
+Create a new resource group
+
+```ruby
+    azure_resources_service.resource_groups.create(
+        name:     '<Resource Group name>',
+        location: 'West US'
+ )
+```
+## List Resource Groups
+
+```ruby
+    azure_resources_service.resource_groups.each do |resource_group|
+        puts "#{resource_group.name}"
+        puts "#{resource_group.location}"
+    end
+```
+
+## Retrieve a single Resource Group
+
+Get a single record of Resource Group
+
+```ruby
+      resource_group = azure_resources_service
+                          .resource_groups
+                          .get('<Resource Group name>')
+      puts "#{resource_group.name}"
+```
+
+## Destroy a single Resource Group
+
+Get resource group object from the get method(described above) and then destroy that resource group.
+
+```ruby
+      resource_group.destroy
+```
+## Tagging a Resource
+
+You can tag a Resource as following:
+
+```ruby
+    azure_resources_service.tag_resource(
+        '<Resource-ID>',
+        '<Tag-Key>',
+        '<Tag-Value>'
+    )
+```
+
+## List Tagged Resources in a Subscription
+
+```ruby
+    azure_resources_service.azure_resources(tag_name: '<Tag-Key>', tag_value: '<Tag-Value>').each do |resource|
+        puts "#{resource.name}"
+        puts "#{resource.location}"
+        puts "#{resource.type}"        
+    end
+```
+OR
+```ruby
+    azure_resources_service.azure_resources(tag_name: '<Tag-Key>').each do |resource|
+        puts "#{resource.name}"
+        puts "#{resource.location}"
+        puts "#{resource.type}"        
+    end
+```
+## Retrieve a single Resource
+
+Get a single record of Tagged Resources
+
+```ruby
+    resource = azure_resources_service
+                          .azure_resources(tag_name: '<Tag-Key>')
+                          .get('<Resource-ID>')
+    puts "#{resource.name}"
+```
+## Remove tag from a Resource
+
+Remove tag from a resource as following:
+
+```ruby
+    azure_resources_service.delete_resource_tag(
+        '<Resource-ID>',
+        '<Tag-Key>',
+        '<Tag-Value>'
+        )
+```
+
+## Create Deployment
+
+Create a Deployment
+
+```ruby
+    azure_resources_service.deployments.create(
+        name:            '<Deployment name>',
+        resource_group:  '<Resource Group name>',
+        template_link:   '<Template Link>',
+        parameters_link: '<Parameters Link>'
+ )
+```
+## List Deployments
+
+List Deployments in a resource group
+
+```ruby
+    azure_resources_service.deployments(resource_group: '<Resource Group Name>').each do |deployment|
+        puts "#{deployment.name}"
+    end
+```
+
+## Retrieve a single Deployment
+
+Get a single record of Deployment
+
+```ruby
+      deployment = azure_resources_service
+                          .deployments
+                          .get('<Resource Group name>', '<Deployment name>')
+      puts "#{deployment.name}"
+```
+
+## Destroy a single Deployment
+
+Get Deployment object from the get method(described above) and then destroy that Deployment.
+
+```ruby
+      deployment.destroy
+```
+
+## Support and Feedback
+Your feedback is appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.

data/lib/fog/azurerm/docs/sql.md

@@ -1,169 +1,169 @@
-#Azure SQL
-
-This document explains how to get started using Azure SQL Services with Fog.
-
-## Usage
-
-First of all, you need to require the Fog library by executing:
-
-```ruby
-require 'fog/azurerm'
-```
-
-## Create Connection
-
-Next, create a connection to the SQL Service:
-
-```ruby
-    azure_sql_service = Fog::Sql::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
-    )
-```
-
-The {server-name} and {database-name} value must be set using all lowercase ANSI letters , hyphen, and the numbers 1 through 9. Do not use a hyphen as the leading or trailing character.
-
-
-## Create SQL Server
-
-Create a new Server
-
-```ruby
-    azure_sql_service.sql_servers.create(
-        name: '<Unique Server Name>',
-        resource_group: '<Resource Group Name>',
-        location: 'East US',
-        version: '2.0',                                # Specifies the version of the Azure server. The acceptable value are: '2.0' or '12.0'
-        administrator_login: 'testserveradmin',        # Specifies the name of the SQL administrator.
-        administrator_login_password: 'svr@admin123'   # Specifies the password of the SQL administrator.
-    )
-```
-For more information, see link: https://msdn.microsoft.com/en-us/library/azure/mt297738.aspx
-
-## List SQL Servers
-Get a list of servers in given resource group
-```ruby
-    servers  = azure_sql_service.sql_servers(resource_group: '<Resource Group Name>')
-    servers.each do |server|
-      puts "Listing : #{server.name}"
-    end
-```
-
-## Retrieve a single SQL Server
-
-Get a single record of SQL Server
-
-```ruby
-     server = azure_sql_service.sql_servers
-                   .get('<Resource Group Name>', '<Server Name>')
-     puts "Server Name: #{server.name}"
-```
-
-## Destroy a SQL Server
-
-Get SQL Server object from the get method(described above) and destroy that Server.
-
-```ruby
-      server.destroy
-```
-
-## Create SQL Database
-
-Creates a new Sql Database
-
-In parameter {create_mode}: 'Copy', 'NonReadableSecondary', and 'OnlineSecondary' are not supported by SQL Data Warehouse.
-
-If parameter {edition} is set to DataWarehouse, the acceptable values for parameter {requested_service_objective_name} are: ['DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1500', 'DW2000', 'DW3000', 'DW6000'] 
-
-```ruby
-    azure_sql_service.sql_databases.create(
-        resource_group: '<Resource Group Name>',
-        location: 'East US',
-        server_name: '<Server Name>',
-        name: '<Database Name>',
-        create_mode: '<Create Mode>',           # Optional. Specifies the type of database to create. The default value is Default. The acceptable values are: [Copy, Default, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, PointInTimeRestore, Restore]
-        edition: '<Edition>',                   # Conditional. Specifies the edition of the database. If createMode is set to Default, then this value must be specified. The acceptable value are: [Basic, Standard, Premium, DataWarehouse]
-        source_database_id: '<URI>',                  # Conditional. Specifies the URI of the source database. If createMode is not set to Default, then this value must be specified.
-        collation: '<Collation>',                     # Conditional. Specifies the name of the collation. If createMode is set to Default, then this value must be specified. 
-        max_size_bytes: '<Size>',                     # Conditional. Specifies the maximum size to which the database may grow. If createMode is set to Default, then this value must be specified.
-        requested_service_objective_name: '<Name>' ,  # Conditional. Specifies the requested service level of the database. If requestedServiceObjectiveId is specified, then this value must not be specified. The acceptable value are: [Basic, S0, S1, S2, S3, P1, P2, P4, P6, P11, ElasticPool]
-        restore_point_in_time: '<String>',            # Conditional. Specifies the point in time for the restore. If createMode is set to PointInTimeRestore, then this value must be specified. 
-        source_database_deletion_date: '<Date>',      # Conditional. Specifies the deletion date of the source database. If createMode is set to Restore, then this value must be specified
-        elastic_pool_name: '<Pool Name>',             # Conditional. Specifies the name of the elastic database pool. If requestedServiceObjectiveId or requestedServiceObjectiveName is set to ElasticPool, then this value must be specified.
-        requested_service_objective_id: '<GUID>'      # Conditional. Specifies the identifier of the requested service level. If requestedServiceObjectiveName is specified, then this value must not be specified.   
-    )
-```
-For more information see link: https://msdn.microsoft.com/en-us/library/azure/mt163685.aspx  
-
-## List SQL Databases
-Get a list of databases in given resource group
-
-```ruby
-    databases  = azure_sql_service.sql_databases(resource_group: '<Resource Group Name>', server_name: '<Server Name>')
-    databases.each do |database|
-      puts "Listing : #{database.name}"
-    end
-```
-
-## Retrieve a single SQL Database
-
-Get a single record of SQL Database
-
-```ruby
-     database = azure_sql_service.sql_databases
-                   .get('<Resource Group Name>', '<Server Name>', '<Database Name>')
-     puts "Database Name: #{database.name}"
-```
-
-## Destroy a SQL Database
-
-Get SQL Database object from the get method(described above) and destroy that Database.
-
-```ruby
-      database.destroy
-```
-
-## Create Firewall Rule
-
-Create a new Firewall Rule
-
-```ruby
-    azure_sql_service.firewall_rules.create(
-        name: '<Firewall Rule Name>',
-        resource_group: '<Resource Group Name>',
-        server_location: '<Server Name>',
-        start_ip: '<Start IP Address>',           # Specifies the starting IP address to allow through the firewall.
-        end_ip: '<End IP Address>',               # Specifies the ending IP address to allow through the firewall.
-        
-    )
-```
-
-## List Firewall Rules
-Get a list of Firewall Rules on a SQL Server in given resource group
-```ruby
-    firewall_rules  = azure_sql_service.firewall_rules(resource_group: '<Resource Group Name>', server_name: '<Server Name>')
-    firewall_rules.each do |firewall_rule|
-      puts "Listing : #{firewall_rule.name}"
-    end
-```
-
-## Retrieve a single Firewall Rule
-Get a single record of Firewall rule on SQL Server
-```ruby
-     firewall_rule = azure_sql_service.firewall_rules
-                   .get('<Resource Group Name>', '<Server Name>', '<Firewall Rule Name>')
-     puts "Get: Firewall Rule Name: #{firewall_rule.name}"
-```
-
-## Destroy a Firewall Rule
-Get Firewall Rule object from the get method(described above) and destroy that Firewall Rule.
-
-```ruby
-      firewall_rule.destroy
-```
-
-
-## Support and Feedback
-Your feedback is appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.
+#Azure SQL
+
+This document explains how to get started using Azure SQL Services with Fog.
+
+## Usage
+
+First of all, you need to require the Fog library by executing:
+
+```ruby
+require 'fog/azurerm'
+```
+
+## Create Connection
+
+Next, create a connection to the SQL Service:
+
+```ruby
+    azure_sql_service = Fog::Sql::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
+    )
+```
+
+The {server-name} and {database-name} value must be set using all lowercase ANSI letters , hyphen, and the numbers 1 through 9. Do not use a hyphen as the leading or trailing character.
+
+
+## Create SQL Server
+
+Create a new Server
+
+```ruby
+    azure_sql_service.sql_servers.create(
+        name: '<Unique Server Name>',
+        resource_group: '<Resource Group Name>',
+        location: 'East US',
+        version: '2.0',                                # Specifies the version of the Azure server. The acceptable value are: '2.0' or '12.0'
+        administrator_login: 'testserveradmin',        # Specifies the name of the SQL administrator.
+        administrator_login_password: 'svr@admin123'   # Specifies the password of the SQL administrator.
+    )
+```
+For more information, see link: https://msdn.microsoft.com/en-us/library/azure/mt297738.aspx
+
+## List SQL Servers
+Get a list of servers in given resource group
+```ruby
+    servers  = azure_sql_service.sql_servers(resource_group: '<Resource Group Name>')
+    servers.each do |server|
+      puts "Listing : #{server.name}"
+    end
+```
+
+## Retrieve a single SQL Server
+
+Get a single record of SQL Server
+
+```ruby
+     server = azure_sql_service.sql_servers
+                   .get('<Resource Group Name>', '<Server Name>')
+     puts "Server Name: #{server.name}"
+```
+
+## Destroy a SQL Server
+
+Get SQL Server object from the get method(described above) and destroy that Server.
+
+```ruby
+      server.destroy
+```
+
+## Create SQL Database
+
+Creates a new Sql Database
+
+In parameter {create_mode}: 'Copy', 'NonReadableSecondary', and 'OnlineSecondary' are not supported by SQL Data Warehouse.
+
+If parameter {edition} is set to DataWarehouse, the acceptable values for parameter {requested_service_objective_name} are: ['DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1500', 'DW2000', 'DW3000', 'DW6000'] 
+
+```ruby
+    azure_sql_service.sql_databases.create(
+        resource_group: '<Resource Group Name>',
+        location: 'East US',
+        server_name: '<Server Name>',
+        name: '<Database Name>',
+        create_mode: '<Create Mode>',           # Optional. Specifies the type of database to create. The default value is Default. The acceptable values are: [Copy, Default, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, PointInTimeRestore, Restore]
+        edition: '<Edition>',                   # Conditional. Specifies the edition of the database. If createMode is set to Default, then this value must be specified. The acceptable value are: [Basic, Standard, Premium, DataWarehouse]
+        source_database_id: '<URI>',                  # Conditional. Specifies the URI of the source database. If createMode is not set to Default, then this value must be specified.
+        collation: '<Collation>',                     # Conditional. Specifies the name of the collation. If createMode is set to Default, then this value must be specified. 
+        max_size_bytes: '<Size>',                     # Conditional. Specifies the maximum size to which the database may grow. If createMode is set to Default, then this value must be specified.
+        requested_service_objective_name: '<Name>' ,  # Conditional. Specifies the requested service level of the database. If requestedServiceObjectiveId is specified, then this value must not be specified. The acceptable value are: [Basic, S0, S1, S2, S3, P1, P2, P4, P6, P11, ElasticPool]
+        restore_point_in_time: '<String>',            # Conditional. Specifies the point in time for the restore. If createMode is set to PointInTimeRestore, then this value must be specified. 
+        source_database_deletion_date: '<Date>',      # Conditional. Specifies the deletion date of the source database. If createMode is set to Restore, then this value must be specified
+        elastic_pool_name: '<Pool Name>',             # Conditional. Specifies the name of the elastic database pool. If requestedServiceObjectiveId or requestedServiceObjectiveName is set to ElasticPool, then this value must be specified.
+        requested_service_objective_id: '<GUID>'      # Conditional. Specifies the identifier of the requested service level. If requestedServiceObjectiveName is specified, then this value must not be specified.   
+    )
+```
+For more information see link: https://msdn.microsoft.com/en-us/library/azure/mt163685.aspx  
+
+## List SQL Databases
+Get a list of databases in given resource group
+
+```ruby
+    databases  = azure_sql_service.sql_databases(resource_group: '<Resource Group Name>', server_name: '<Server Name>')
+    databases.each do |database|
+      puts "Listing : #{database.name}"
+    end
+```
+
+## Retrieve a single SQL Database
+
+Get a single record of SQL Database
+
+```ruby
+     database = azure_sql_service.sql_databases
+                   .get('<Resource Group Name>', '<Server Name>', '<Database Name>')
+     puts "Database Name: #{database.name}"
+```
+
+## Destroy a SQL Database
+
+Get SQL Database object from the get method(described above) and destroy that Database.
+
+```ruby
+      database.destroy
+```
+
+## Create Firewall Rule
+
+Create a new Firewall Rule
+
+```ruby
+    azure_sql_service.firewall_rules.create(
+        name: '<Firewall Rule Name>',
+        resource_group: '<Resource Group Name>',
+        server_location: '<Server Name>',
+        start_ip: '<Start IP Address>',           # Specifies the starting IP address to allow through the firewall.
+        end_ip: '<End IP Address>',               # Specifies the ending IP address to allow through the firewall.
+        
+    )
+```
+
+## List Firewall Rules
+Get a list of Firewall Rules on a SQL Server in given resource group
+```ruby
+    firewall_rules  = azure_sql_service.firewall_rules(resource_group: '<Resource Group Name>', server_name: '<Server Name>')
+    firewall_rules.each do |firewall_rule|
+      puts "Listing : #{firewall_rule.name}"
+    end
+```
+
+## Retrieve a single Firewall Rule
+Get a single record of Firewall rule on SQL Server
+```ruby
+     firewall_rule = azure_sql_service.firewall_rules
+                   .get('<Resource Group Name>', '<Server Name>', '<Firewall Rule Name>')
+     puts "Get: Firewall Rule Name: #{firewall_rule.name}"
+```
+
+## Destroy a Firewall Rule
+Get Firewall Rule object from the get method(described above) and destroy that Firewall Rule.
+
+```ruby
+      firewall_rule.destroy
+```
+
+
+## Support and Feedback
+Your feedback is appreciated! If you have specific issues with the fog ARM, you should file an issue via Github.