Class: Azure::ARM::Network::NetworkManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/generated/azure_mgmt_network/network_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ NetworkManagementClient

Creates initializes a new instance of the NetworkManagementClient class.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 120

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @application_gateways = ApplicationGateways.new(self)
  @express_route_circuit_authorizations = ExpressRouteCircuitAuthorizations.new(self)
  @express_route_circuit_peerings = ExpressRouteCircuitPeerings.new(self)
  @express_route_circuits = ExpressRouteCircuits.new(self)
  @express_route_service_providers = ExpressRouteServiceProviders.new(self)
  @load_balancers = LoadBalancers.new(self)
  @network_interfaces = NetworkInterfaces.new(self)
  @network_security_groups = NetworkSecurityGroups.new(self)
  @security_rules = SecurityRules.new(self)
  @network_watchers = NetworkWatchers.new(self)
  @packet_captures = PacketCaptures.new(self)
  @available_private_access_services = AvailablePrivateAccessServices.new(self)
  @public_ipaddresses = PublicIPAddresses.new(self)
  @route_filters = RouteFilters.new(self)
  @route_filter_rules = RouteFilterRules.new(self)
  @route_tables = RouteTables.new(self)
  @routes = Routes.new(self)
  @bgp_service_communities = BgpServiceCommunities.new(self)
  @usages = Usages.new(self)
  @virtual_networks = VirtualNetworks.new(self)
  @subnets = Subnets.new(self)
  @virtual_network_peerings = VirtualNetworkPeerings.new(self)
  @virtual_network_gateways = VirtualNetworkGateways.new(self)
  @virtual_network_gateway_connections = VirtualNetworkGatewayConnections.new(self)
  @local_network_gateways = LocalNetworkGateways.new(self)
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String 



26
27
28
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 26

def accept_language
  @accept_language
end

#application_gateways ⇒ ApplicationGateways (readonly) 



37
38
39
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 37

def application_gateways
  @application_gateways
end

#available_private_access_services ⇒ AvailablePrivateAccessServices (readonly)

available_private_access_services



72
73
74
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 72

def available_private_access_services
  @available_private_access_services
end

#base_url ⇒ String 



15
16
17
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 15

def base_url
  @base_url
end

#bgp_service_communities ⇒ BgpServiceCommunities (readonly) 



90
91
92
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 90

def bgp_service_communities
  @bgp_service_communities
end

#credentials ⇒ Object (readonly) 



18
19
20
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 18

def credentials
  @credentials
end

#express_route_circuit_authorizations ⇒ ExpressRouteCircuitAuthorizations (readonly)

express_route_circuit_authorizations



41
42
43
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 41

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_peerings ⇒ ExpressRouteCircuitPeerings (readonly) 



44
45
46
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 44

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuits ⇒ ExpressRouteCircuits (readonly) 



47
48
49
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 47

def express_route_circuits
  @express_route_circuits
end

#express_route_service_providers ⇒ ExpressRouteServiceProviders (readonly) 



50
51
52
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 50

def express_route_service_providers
  @express_route_service_providers
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.



34
35
36
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 34

def generate_client_request_id
  @generate_client_request_id
end

#load_balancers ⇒ LoadBalancers (readonly) 



53
54
55
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 53

def load_balancers
  @load_balancers
end

#local_network_gateways ⇒ LocalNetworkGateways (readonly) 



112
113
114
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 112

def local_network_gateways
  @local_network_gateways
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.



30
31
32
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 30

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#network_interfaces ⇒ NetworkInterfaces (readonly) 



56
57
58
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 56

def network_interfaces
  @network_interfaces
end

#network_security_groups ⇒ NetworkSecurityGroups (readonly) 



59
60
61
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 59

def network_security_groups
  @network_security_groups
end

#network_watchers ⇒ NetworkWatchers (readonly) 



65
66
67
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 65

def network_watchers
  @network_watchers
end

#packet_captures ⇒ PacketCaptures (readonly) 



68
69
70
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 68

def packet_captures
  @packet_captures
end

#public_ipaddresses ⇒ PublicIPAddresses (readonly) 



75
76
77
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 75

def public_ipaddresses
  @public_ipaddresses
end

#route_filter_rules ⇒ RouteFilterRules (readonly) 



81
82
83
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 81

def route_filter_rules
  @route_filter_rules
end

#route_filters ⇒ RouteFilters (readonly) 



78
79
80
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 78

def route_filters
  @route_filters
end

#route_tables ⇒ RouteTables (readonly) 



84
85
86
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 84

def route_tables
  @route_tables
end

#routes ⇒ Routes (readonly) 



87
88
89
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 87

def routes
  @routes
end

#security_rules ⇒ SecurityRules (readonly) 



62
63
64
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 62

def security_rules
  @security_rules
end

#subnets ⇒ Subnets (readonly) 



99
100
101
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 99

def subnets
  @subnets
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.



23
24
25
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#usages ⇒ Usages (readonly) 



93
94
95
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 93

def usages
  @usages
end

#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections



109
110
111
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 109

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gateways ⇒ VirtualNetworkGateways (readonly) 



105
106
107
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 105

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peerings ⇒ VirtualNetworkPeerings (readonly) 



102
103
104
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 102

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_networks ⇒ VirtualNetworks (readonly) 



96
97
98
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 96

def virtual_networks
  @virtual_networks
end

Instance Method Details

#check_dns_name_availability(location, domain_name_label = nil, custom_headers = nil) ⇒ DnsNameAvailabilityResult

Checks whether a domain name in the cloudapp.net zone is available for use.

conform to the following regular expression: ^[a-z]1,61$. will be added to the HTTP request.



224
225
226
227
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 224

def check_dns_name_availability(location, domain_name_label = nil, custom_headers = nil)
  response = check_dns_name_availability_async(location, domain_name_label, custom_headers).value!
  response.body unless response.nil?
end

#check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil) ⇒ Concurrent::Promise

Checks whether a domain name in the cloudapp.net zone is available for use.

conform to the following regular expression: ^[a-z]1,61$. to the HTTP request.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 255

def check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil)
  fail ArgumentError, 'location is nil' if location.nil?
  api_version = '2017-06-01'
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'subscriptionId' => subscription_id},
      query_params: {'domainNameLabel' => domain_name_label,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::DnsNameAvailabilityResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#check_dns_name_availability_with_http_info(location, domain_name_label = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Checks whether a domain name in the cloudapp.net zone is available for use.

conform to the following regular expression: ^[a-z]1,61$. will be added to the HTTP request.



240
241
242
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 240

def check_dns_name_availability_with_http_info(location, domain_name_label = nil, custom_headers = nil)
  check_dns_name_availability_async(location, domain_name_label, custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)



174
175
176
177
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 174

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 199

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.



186
187
188
189
190
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 186

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end