Class: Azure::Network::Mgmt::V2018_06_01::NetworkManagementClient

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 201

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

  @azure_firewalls = AzureFirewalls.new(self)
  @application_gateways = ApplicationGateways.new(self)
  @application_security_groups = ApplicationSecurityGroups.new(self)
  @ddos_protection_plans = DdosProtectionPlans.new(self)
  @available_endpoint_services = AvailableEndpointServices.new(self)
  @express_route_circuit_authorizations = ExpressRouteCircuitAuthorizations.new(self)
  @express_route_circuit_peerings = ExpressRouteCircuitPeerings.new(self)
  @express_route_circuit_connections = ExpressRouteCircuitConnections.new(self)
  @express_route_circuits = ExpressRouteCircuits.new(self)
  @express_route_service_providers = ExpressRouteServiceProviders.new(self)
  @express_route_cross_connections = ExpressRouteCrossConnections.new(self)
  @express_route_cross_connection_peerings = ExpressRouteCrossConnectionPeerings.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)
  @virtual_wans = VirtualWANs.new(self)
  @vpn_sites = VpnSites.new(self)
  @vpn_sites_configuration = VpnSitesConfiguration.new(self)
  @virtual_hubs = VirtualHubs.new(self)
  @hub_virtual_network_connections = HubVirtualNetworkConnections.new(self)
  @vpn_gateways = VpnGateways.new(self)
  @vpn_connections = VpnConnections.new(self)
  @api_version = '2018-06-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_languageString

Returns The preferred language for the response.

Returns:

  • (String)

    The preferred language for the response.



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

def accept_language
  @accept_language
end

#api_versionString (readonly)

Returns Client API version.

Returns:

  • (String)

    Client API version.



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

def api_version
  @api_version
end

#application_gatewaysApplicationGateways (readonly)

Returns application_gateways.

Returns:



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

def application_gateways
  @application_gateways
end

#application_security_groupsApplicationSecurityGroups (readonly)

Returns application_security_groups.

Returns:



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

def application_security_groups
  @application_security_groups
end

#available_endpoint_servicesAvailableEndpointServices (readonly)

Returns available_endpoint_services.

Returns:



53
54
55
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 53

def available_endpoint_services
  @available_endpoint_services
end

#azure_firewallsAzureFirewalls (readonly)

Returns azure_firewalls.

Returns:



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

def azure_firewalls
  @azure_firewalls
end

#base_urlString

Returns the base URI of the service.

Returns:

  • (String)

    the base URI of the service.



15
16
17
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 15

def base_url
  @base_url
end

#bgp_service_communitiesBgpServiceCommunities (readonly)

Returns bgp_service_communities.

Returns:



150
151
152
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 150

def bgp_service_communities
  @bgp_service_communities
end

#connection_monitorsConnectionMonitors (readonly)

Returns connection_monitors.

Returns:



129
130
131
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 129

def connection_monitors
  @connection_monitors
end

#credentialsObject (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/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 18

def credentials
  @credentials
end

#ddos_protection_plansDdosProtectionPlans (readonly)

Returns ddos_protection_plans.

Returns:



50
51
52
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 50

def ddos_protection_plans
  @ddos_protection_plans
end

#default_security_rulesDefaultSecurityRules (readonly)

Returns default_security_rules.

Returns:



120
121
122
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 120

def default_security_rules
  @default_security_rules
end

#express_route_circuit_authorizationsExpressRouteCircuitAuthorizations (readonly)

express_route_circuit_authorizations



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

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_connectionsExpressRouteCircuitConnections (readonly)

express_route_circuit_connections



64
65
66
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 64

def express_route_circuit_connections
  @express_route_circuit_connections
end

#express_route_circuit_peeringsExpressRouteCircuitPeerings (readonly)

Returns express_route_circuit_peerings.

Returns:



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

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuitsExpressRouteCircuits (readonly)

Returns express_route_circuits.

Returns:



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

def express_route_circuits
  @express_route_circuits
end

#express_route_cross_connection_peeringsExpressRouteCrossConnectionPeerings (readonly)

express_route_cross_connection_peerings



77
78
79
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 77

def express_route_cross_connection_peerings
  @express_route_cross_connection_peerings
end

#express_route_cross_connectionsExpressRouteCrossConnections (readonly)

Returns express_route_cross_connections.

Returns:



73
74
75
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 73

def express_route_cross_connections
  @express_route_cross_connections
end

#express_route_service_providersExpressRouteServiceProviders (readonly)

Returns express_route_service_providers.

Returns:



70
71
72
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 70

def express_route_service_providers
  @express_route_service_providers
end

#generate_client_request_idBoolean

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/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#hub_virtual_network_connectionsHubVirtualNetworkConnections (readonly)

Returns hub_virtual_network_connections.

Returns:



187
188
189
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 187

def hub_virtual_network_connections
  @hub_virtual_network_connections
end

#inbound_nat_rulesInboundNatRules (readonly)

Returns inbound_nat_rules.

Returns:



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

def inbound_nat_rules
  @inbound_nat_rules
end

#load_balancer_backend_address_poolsLoadBalancerBackendAddressPools (readonly)

load_balancer_backend_address_pools



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

def load_balancer_backend_address_pools
  @load_balancer_backend_address_pools
end

#load_balancer_frontend_ipconfigurationsLoadBalancerFrontendIPConfigurations (readonly)

load_balancer_frontend_ipconfigurations



88
89
90
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 88

def load_balancer_frontend_ipconfigurations
  @load_balancer_frontend_ipconfigurations
end

#load_balancer_load_balancing_rulesLoadBalancerLoadBalancingRules (readonly)

load_balancer_load_balancing_rules



95
96
97
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 95

def load_balancer_load_balancing_rules
  @load_balancer_load_balancing_rules
end

#load_balancer_network_interfacesLoadBalancerNetworkInterfaces (readonly)

Returns load_balancer_network_interfaces.

Returns:



98
99
100
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 98

def load_balancer_network_interfaces
  @load_balancer_network_interfaces
end

#load_balancer_probesLoadBalancerProbes (readonly)

Returns load_balancer_probes.

Returns:



101
102
103
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 101

def load_balancer_probes
  @load_balancer_probes
end

#load_balancersLoadBalancers (readonly)

Returns load_balancers.

Returns:



80
81
82
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 80

def load_balancers
  @load_balancers
end

#local_network_gatewaysLocalNetworkGateways (readonly)

Returns local_network_gateways.

Returns:



172
173
174
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 172

def local_network_gateways
  @local_network_gateways
end

#long_running_operation_retry_timeoutInteger

Operations. Default value is 30.

Returns:

  • (Integer)

    The retry timeout in seconds for Long Running



33
34
35
# File 'lib/2018-06-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_ipconfigurationsNetworkInterfaceIPConfigurations (readonly)

network_interface_ipconfigurations



108
109
110
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 108

def network_interface_ipconfigurations
  @network_interface_ipconfigurations
end

#network_interface_load_balancersNetworkInterfaceLoadBalancers (readonly)

Returns network_interface_load_balancers.

Returns:



111
112
113
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 111

def network_interface_load_balancers
  @network_interface_load_balancers
end

#network_interfacesNetworkInterfaces (readonly)

Returns network_interfaces.

Returns:



104
105
106
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 104

def network_interfaces
  @network_interfaces
end

#network_security_groupsNetworkSecurityGroups (readonly)

Returns network_security_groups.

Returns:



114
115
116
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 114

def network_security_groups
  @network_security_groups
end

#network_watchersNetworkWatchers (readonly)

Returns network_watchers.

Returns:



123
124
125
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 123

def network_watchers
  @network_watchers
end

#operationsOperations (readonly)

Returns operations.

Returns:



132
133
134
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 132

def operations
  @operations
end

#packet_capturesPacketCaptures (readonly)

Returns packet_captures.

Returns:



126
127
128
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 126

def packet_captures
  @packet_captures
end

#public_ipaddressesPublicIPAddresses (readonly)

Returns public_ipaddresses.

Returns:



135
136
137
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 135

def public_ipaddresses
  @public_ipaddresses
end

#route_filter_rulesRouteFilterRules (readonly)

Returns route_filter_rules.

Returns:



141
142
143
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 141

def route_filter_rules
  @route_filter_rules
end

#route_filtersRouteFilters (readonly)

Returns route_filters.

Returns:



138
139
140
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 138

def route_filters
  @route_filters
end

#route_tablesRouteTables (readonly)

Returns route_tables.

Returns:



144
145
146
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 144

def route_tables
  @route_tables
end

#routesRoutes (readonly)

Returns routes.

Returns:



147
148
149
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 147

def routes
  @routes
end

#security_rulesSecurityRules (readonly)

Returns security_rules.

Returns:



117
118
119
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 117

def security_rules
  @security_rules
end

#subnetsSubnets (readonly)

Returns subnets.

Returns:



159
160
161
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 159

def subnets
  @subnets
end

#subscription_idString

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

def subscription_id
  @subscription_id
end

#usagesUsages (readonly)

Returns usages.

Returns:



153
154
155
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 153

def usages
  @usages
end

#virtual_hubsVirtualHubs (readonly)

Returns virtual_hubs.

Returns:



184
185
186
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 184

def virtual_hubs
  @virtual_hubs
end

#virtual_network_gateway_connectionsVirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections



169
170
171
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 169

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gatewaysVirtualNetworkGateways (readonly)

Returns virtual_network_gateways.

Returns:



165
166
167
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 165

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peeringsVirtualNetworkPeerings (readonly)

Returns virtual_network_peerings.

Returns:



162
163
164
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 162

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_networksVirtualNetworks (readonly)

Returns virtual_networks.

Returns:



156
157
158
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 156

def virtual_networks
  @virtual_networks
end

#virtual_wansVirtualWANs (readonly)

Returns virtual_wans.

Returns:



175
176
177
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 175

def virtual_wans
  @virtual_wans
end

#vpn_connectionsVpnConnections (readonly)

Returns vpn_connections.

Returns:



193
194
195
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 193

def vpn_connections
  @vpn_connections
end

#vpn_gatewaysVpnGateways (readonly)

Returns vpn_gateways.

Returns:



190
191
192
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 190

def vpn_gateways
  @vpn_gateways
end

#vpn_sitesVpnSites (readonly)

Returns vpn_sites.

Returns:



178
179
180
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 178

def vpn_sites
  @vpn_sites
end

#vpn_sites_configurationVpnSitesConfiguration (readonly)

Returns vpn_sites_configuration.

Returns:



181
182
183
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 181

def vpn_sites_configuration
  @vpn_sites_configuration
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.



334
335
336
337
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 334

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.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 367

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::V2018_06_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.



351
352
353
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 351

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.



280
281
282
283
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 280

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.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 305

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.



292
293
294
295
296
# File 'lib/2018-06-01/generated/azure_mgmt_network/network_management_client.rb', line 292

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