1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# Intro
This project provides a Ruby gem for easy access to the Azure ARM Network API. With this gem you can create/update/list/delete virtual networks, subnets, load balancers and network interfaces.
# Supported Ruby Versions
* Ruby 2+
Note: x64 Ruby for Windows is known to have some compatibility issues.
# Getting started
## Setting up the service principal
First of all to start interacting with the ARM network you will need to setup a service principal. Service principal is an Azure application which allows you to authenticate to Azure and access Azure services. The detailed steps of how to setup a service principal can be found in this article: http://aka.ms/cli-service-principal. In the result of setting up service principal you will get tenant id, client id and client secret data.
## Installation
install the appropriate gem:
```
gem install azure_mgmt_network
```
and reference it in your code:
```Ruby
require 'azure_mgmt_network'
```
After that you should be ready to start using SDK!
## Authentication
```Ruby
# Create authentication objects
token_provider = MsRestAzure::ApplicationTokenProvider.new(tenant_id, client_id, secret)
credentials = MsRest::TokenCredentials.new(token_provider)
```
To get tenant_id, client_id and secret for your Azure application visit Azure portal or copy them from the powershell script from the article mentioned above.
## Creating new virtual network
```Ruby
# Include SDK modules to ease access to network classes.
include Azure::ARM::Network
include Azure::ARM::Network::Models
# Create a client - a point of access to the API and set the subscription id
client = NetworkManagementClient.new(credentials)
client.subscription_id = subscription_id
# Create a model for new virtual network
params = VirtualNetwork.new
address_space = AddressSpace.new
address_space.address_prefixes = ['10.0.0.0/16']
params.address_space = address_space
dhcp_options = DhcpOptions.new
dhcp_options.dns_servers = %w(10.1.1.1 10.1.2.4)
params.dhcp_options = dhcp_options
sub = Subnet.new
sub.name = 'new_subnet'
sub.address_prefix = '10.0.2.0/24'
params.subnets = [sub]
params.location = 'westus'
promise = client.virtual_networks.create_or_update_async('existing_resource_group', 'new_vn', params)
```
The SDK method returns a promise which you can utilize depending on your needs. E.g. if you need to get result immediately via sync blocking call - do the following:
```Ruby
result = promise.value!
```
If you need to follow async flow - provide a block which will be executed in off main thread:
```Ruby
promise = promise.then do |result|
# Handle the result
end
```
In both cases you're returned an instance of MsRestAzure::AzureOperationResponse which contains HTTP requests/response objects and response body. Response body is a deserialized object representing the received information. In case of code above - newly created virtual network. To get data from it:
```Ruby
virtual_network = result.body
p virtual_network.name # name of the new vn
p virtual_network.id # id of the new vn
```
Congrats, you've create new virtual network. We encourage you to try more stuff and let us know your feedback!
For advanced SDK usage please reference to the spec files.
|
