Class: Azure::Network::Mgmt::V2017_10_01::NetworkManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-10-01/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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 163

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)
  @application_security_groups = ApplicationSecurityGroups.new(self)
  @available_endpoint_services = AvailableEndpointServices.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)
  @load_balancer_backend_address_pools = LoadBalancerBackendAddressPools.new(self)
  @load_balancer_frontend_ipconfigurations = LoadBalancerFrontendIPConfigurations.new(self)
  @inbound_nat_rules = InboundNatRules.new(self)
  @load_balancer_load_balancing_rules = LoadBalancerLoadBalancingRules.new(self)
  @load_balancer_network_interfaces = LoadBalancerNetworkInterfaces.new(self)
  @load_balancer_probes = LoadBalancerProbes.new(self)
  @network_interfaces = NetworkInterfaces.new(self)
  @network_interface_ipconfigurations = NetworkInterfaceIPConfigurations.new(self)
  @network_interface_load_balancers = NetworkInterfaceLoadBalancers.new(self)
  @network_security_groups = NetworkSecurityGroups.new(self)
  @security_rules = SecurityRules.new(self)
  @default_security_rules = DefaultSecurityRules.new(self)
  @network_watchers = NetworkWatchers.new(self)
  @packet_captures = PacketCaptures.new(self)
  @connection_monitors = ConnectionMonitors.new(self)
  @operations = Operations.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)
  @api_version = '2017-10-01'
  @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 The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client API version.

Returns:

  • (String) —

    Client API version.



26
27
28
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 26

def api_version
  @api_version
end

#application_gateways ⇒ ApplicationGateways (readonly)

Returns application_gateways.

Returns:



41
42
43
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 41

def application_gateways
  @application_gateways
end

#application_security_groups ⇒ ApplicationSecurityGroups (readonly)

Returns application_security_groups.

Returns:



44
45
46
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 44

def application_security_groups
  @application_security_groups
end

#available_endpoint_services ⇒ AvailableEndpointServices (readonly)

Returns available_endpoint_services.

Returns:



47
48
49
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 47

def available_endpoint_services
  @available_endpoint_services
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2017-10-01/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:



133
134
135
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 133

def bgp_service_communities
  @bgp_service_communities
end

#connection_monitors ⇒ ConnectionMonitors (readonly)

Returns connection_monitors.

Returns:



112
113
114
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 112

def connection_monitors
  @connection_monitors
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/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 18

def credentials
  @credentials
end

#default_security_rules ⇒ DefaultSecurityRules (readonly)

Returns default_security_rules.

Returns:



103
104
105
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 103

def default_security_rules
  @default_security_rules
end

#express_route_circuit_authorizations ⇒ ExpressRouteCircuitAuthorizations (readonly)

express_route_circuit_authorizations

Returns:



51
52
53
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 51

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_peerings ⇒ ExpressRouteCircuitPeerings (readonly)

Returns express_route_circuit_peerings.

Returns:



54
55
56
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 54

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuits ⇒ ExpressRouteCircuits (readonly)

Returns express_route_circuits.

Returns:



57
58
59
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 57

def express_route_circuits
  @express_route_circuits
end

#express_route_service_providers ⇒ ExpressRouteServiceProviders (readonly)

Returns express_route_service_providers.

Returns:



60
61
62
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 60

def express_route_service_providers
  @express_route_service_providers
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#inbound_nat_rules ⇒ InboundNatRules (readonly)

Returns inbound_nat_rules.

Returns:



74
75
76
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 74

def inbound_nat_rules
  @inbound_nat_rules
end

#load_balancer_backend_address_pools ⇒ LoadBalancerBackendAddressPools (readonly)

load_balancer_backend_address_pools

Returns:



67
68
69
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 67

def load_balancer_backend_address_pools
  @load_balancer_backend_address_pools
end

#load_balancer_frontend_ipconfigurations ⇒ LoadBalancerFrontendIPConfigurations (readonly)

load_balancer_frontend_ipconfigurations

Returns:



71
72
73
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 71

def load_balancer_frontend_ipconfigurations
  @load_balancer_frontend_ipconfigurations
end

#load_balancer_load_balancing_rules ⇒ LoadBalancerLoadBalancingRules (readonly)

load_balancer_load_balancing_rules

Returns:



78
79
80
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 78

def load_balancer_load_balancing_rules
  @load_balancer_load_balancing_rules
end

#load_balancer_network_interfaces ⇒ LoadBalancerNetworkInterfaces (readonly)

Returns load_balancer_network_interfaces.

Returns:



81
82
83
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 81

def load_balancer_network_interfaces
  @load_balancer_network_interfaces
end

#load_balancer_probes ⇒ LoadBalancerProbes (readonly)

Returns load_balancer_probes.

Returns:



84
85
86
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 84

def load_balancer_probes
  @load_balancer_probes
end

#load_balancers ⇒ LoadBalancers (readonly)

Returns load_balancers.

Returns:



63
64
65
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 63

def load_balancers
  @load_balancers
end

#local_network_gateways ⇒ LocalNetworkGateways (readonly)

Returns local_network_gateways.

Returns:



155
156
157
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 155

def local_network_gateways
  @local_network_gateways
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#network_interface_ipconfigurations ⇒ NetworkInterfaceIPConfigurations (readonly)

network_interface_ipconfigurations

Returns:



91
92
93
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 91

def network_interface_ipconfigurations
  @network_interface_ipconfigurations
end

#network_interface_load_balancers ⇒ NetworkInterfaceLoadBalancers (readonly)

Returns network_interface_load_balancers.

Returns:



94
95
96
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 94

def network_interface_load_balancers
  @network_interface_load_balancers
end

#network_interfaces ⇒ NetworkInterfaces (readonly)

Returns network_interfaces.

Returns:



87
88
89
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 87

def network_interfaces
  @network_interfaces
end

#network_security_groups ⇒ NetworkSecurityGroups (readonly)

Returns network_security_groups.

Returns:



97
98
99
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 97

def network_security_groups
  @network_security_groups
end

#network_watchers ⇒ NetworkWatchers (readonly)

Returns network_watchers.

Returns:



106
107
108
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 106

def network_watchers
  @network_watchers
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



115
116
117
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 115

def operations
  @operations
end

#packet_captures ⇒ PacketCaptures (readonly)

Returns packet_captures.

Returns:



109
110
111
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 109

def packet_captures
  @packet_captures
end

#public_ipaddresses ⇒ PublicIPAddresses (readonly)

Returns public_ipaddresses.

Returns:



118
119
120
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 118

def public_ipaddresses
  @public_ipaddresses
end

#route_filter_rules ⇒ RouteFilterRules (readonly)

Returns route_filter_rules.

Returns:



124
125
126
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 124

def route_filter_rules
  @route_filter_rules
end

#route_filters ⇒ RouteFilters (readonly)

Returns route_filters.

Returns:



121
122
123
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 121

def route_filters
  @route_filters
end

#route_tables ⇒ RouteTables (readonly)

Returns route_tables.

Returns:



127
128
129
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 127

def route_tables
  @route_tables
end

#routes ⇒ Routes (readonly)

Returns routes.

Returns:



130
131
132
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 130

def routes
  @routes
end

#security_rules ⇒ SecurityRules (readonly)

Returns security_rules.

Returns:



100
101
102
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 100

def security_rules
  @security_rules
end

#subnets ⇒ Subnets (readonly)

Returns subnets.

Returns:



142
143
144
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 142

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/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#usages ⇒ Usages (readonly)

Returns usages.

Returns:



136
137
138
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 136

def usages
  @usages
end

#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections

Returns:



152
153
154
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 152

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gateways ⇒ VirtualNetworkGateways (readonly)

Returns virtual_network_gateways.

Returns:



148
149
150
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 148

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peerings ⇒ VirtualNetworkPeerings (readonly)

Returns virtual_network_peerings.

Returns:



145
146
147
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 145

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_networks ⇒ VirtualNetworks (readonly)

Returns virtual_networks.

Returns:



139
140
141
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 139

def virtual_networks
  @virtual_networks
end

Instance Method Details

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

Checks whether a domain name in the cloudapp.azure.com 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) —

    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.



284
285
286
287
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 284

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

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

Checks whether a domain name in the cloudapp.azure.com 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) —

    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.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 317

def check_dns_name_availability_async(location, domain_name_label, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'domain_name_label is nil' if domain_name_label.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Network::Mgmt::V2017_10_01::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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks whether a domain name in the cloudapp.azure.com 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) —

    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.



301
302
303
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 301

def check_dns_name_availability_with_http_info(location, domain_name_label, custom_headers:nil)
  check_dns_name_availability_async(location, domain_name_label, custom_headers: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.



230
231
232
233
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 230

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.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 255

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
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  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.



242
243
244
245
246
 
# File 'lib/2017-10-01/generated/azure_mgmt_network/network_management_client.rb', line 242

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