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.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



116
117
118
119
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
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 116

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)
  @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

Returns Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



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)

Returns application_gateways.

Returns:



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

def application_gateways
  @application_gateways
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



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)

Returns bgp_service_communities.

Returns:



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

def bgp_service_communities
  @bgp_service_communities
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



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

Returns:



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)

Returns express_route_circuit_peerings.

Returns:



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)

Returns express_route_circuits.

Returns:



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)

Returns express_route_service_providers.

Returns:



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.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



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)

Returns load_balancers.

Returns:



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)

Returns local_network_gateways.

Returns:



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

def local_network_gateways
  @local_network_gateways
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



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)

Returns network_interfaces.

Returns:



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)

Returns network_security_groups.

Returns:



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)

Returns network_watchers.

Returns:



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)

Returns packet_captures.

Returns:



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)

Returns public_ipaddresses.

Returns:



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

def public_ipaddresses
  @public_ipaddresses
end

#route_filter_rules ⇒ RouteFilterRules (readonly)

Returns route_filter_rules.

Returns:



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

def route_filter_rules
  @route_filter_rules
end

#route_filters ⇒ RouteFilters (readonly)

Returns route_filters.

Returns:



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

def route_filters
  @route_filters
end

#route_tables ⇒ RouteTables (readonly)

Returns route_tables.

Returns:



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

def route_tables
  @route_tables
end

#routes ⇒ Routes (readonly)

Returns routes.

Returns:



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

def routes
  @routes
end

#security_rules ⇒ SecurityRules (readonly)

Returns security_rules.

Returns:



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

def security_rules
  @security_rules
end

#subnets ⇒ Subnets (readonly)

Returns subnets.

Returns:



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

def subnets
  @subnets
end

#subscription_id ⇒ String

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

Returns:

  • (String) —

    The subscription credentials which uniquely identify the



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

def subscription_id
  @subscription_id
end

#usages ⇒ Usages (readonly)

Returns usages.

Returns:



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

def usages
  @usages
end

#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections

Returns:



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

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gateways ⇒ VirtualNetworkGateways (readonly)

Returns virtual_network_gateways.

Returns:



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

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peerings ⇒ VirtualNetworkPeerings (readonly)

Returns virtual_network_peerings.

Returns:



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

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_networks ⇒ VirtualNetworks (readonly)

Returns virtual_networks.

Returns:



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

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.

Parameters:

  • location (String) —

    The location of the domain name.

  • domain_name_label (String) (defaults to: nil) —

    The domain name to be verified. It must

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DnsNameAvailabilityResult) —

    operation results.



219
220
221
222
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 219

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.

Parameters:

  • location (String) —

    The location of the domain name.

  • domain_name_label (String) (defaults to: nil) —

    The domain name to be verified. It must

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



250
251
252
253
254
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
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 250

def check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil)
  fail ArgumentError, 'location is nil' if location.nil?
  api_version = '2016-12-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 = DnsNameAvailabilityResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response, 'result.body')
      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.

Parameters:

  • location (String) —

    The location of the domain name.

  • domain_name_label (String) (defaults to: nil) —

    The domain name to be verified. It must

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



235
236
237
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 235

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)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



169
170
171
172
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 169

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.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 194

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.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



181
182
183
184
185
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 181

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