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, base_url = nil, options = nil) ⇒ NetworkManagementClient

Creates initializes a new instance of the NetworkManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) —

    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.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 108

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

  fail ArgumentError, 'credentials is nil' if credentials.nil?
  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials)
  @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)
  @local_network_gateways = LocalNetworkGateways.new(self)
  @network_interfaces = NetworkInterfaces.new(self)
  @network_security_groups = NetworkSecurityGroups.new(self)
  @public_ipaddresses = PublicIPAddresses.new(self)
  @route_tables = RouteTables.new(self)
  @routes = Routes.new(self)
  @security_rules = SecurityRules.new(self)
  @subnets = Subnets.new(self)
  @virtual_network_peerings = VirtualNetworkPeerings.new(self)
  @usages = Usages.new(self)
  @virtual_network_gateway_connections = VirtualNetworkGatewayConnections.new(self)
  @virtual_network_gateways = VirtualNetworkGateways.new(self)
  @virtual_networks = VirtualNetworks.new(self)
  @api_version = '2016-06-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
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.



29
30
31
 
# File 'lib/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/generated/azure_mgmt_network/network_management_client.rb', line 26

def api_version
  @api_version
end

#application_gateways ⇒ ApplicationGateways (readonly)

Returns application_gateways.

Returns:



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

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

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



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:



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

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_peerings ⇒ ExpressRouteCircuitPeerings (readonly)

Returns express_route_circuit_peerings.

Returns:



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

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuits ⇒ ExpressRouteCircuits (readonly)

Returns express_route_circuits.

Returns:



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

def express_route_circuits
  @express_route_circuits
end

#express_route_service_providers ⇒ ExpressRouteServiceProviders (readonly)

Returns express_route_service_providers.

Returns:



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

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



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

def generate_client_request_id
  @generate_client_request_id
end

#load_balancers ⇒ LoadBalancers (readonly)

Returns load_balancers.

Returns:



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

def load_balancers
  @load_balancers
end

#local_network_gateways ⇒ LocalNetworkGateways (readonly)

Returns local_network_gateways.

Returns:



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

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



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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#network_interfaces ⇒ NetworkInterfaces (readonly)

Returns network_interfaces.

Returns:



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

def network_interfaces
  @network_interfaces
end

#network_security_groups ⇒ NetworkSecurityGroups (readonly)

Returns network_security_groups.

Returns:



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

def network_security_groups
  @network_security_groups
end

#public_ipaddresses ⇒ PublicIPAddresses (readonly)

Returns public_ipaddresses.

Returns:



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

def public_ipaddresses
  @public_ipaddresses
end

#route_tables ⇒ RouteTables (readonly)

Returns route_tables.

Returns:



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

def route_tables
  @route_tables
end

#routes ⇒ Routes (readonly)

Returns routes.

Returns:



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

def routes
  @routes
end

#security_rules ⇒ SecurityRules (readonly)

Returns security_rules.

Returns:



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

def security_rules
  @security_rules
end

#subnets ⇒ Subnets (readonly)

Returns subnets.

Returns:



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

def subnets
  @subnets
end

#subscription_id ⇒ String

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

Returns:

  • (String) —

    Gets subscription credentials which uniquely identify



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:



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

def usages
  @usages
end

#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections

Returns:



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

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gateways ⇒ VirtualNetworkGateways (readonly)

Returns virtual_network_gateways.

Returns:



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

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peerings ⇒ VirtualNetworkPeerings (readonly)

Returns virtual_network_peerings.

Returns:



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

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_networks ⇒ VirtualNetworks (readonly)

Returns virtual_networks.

Returns:



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

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][a-z0-9-]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.



152
153
154
155
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 152

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][a-z0-9-]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.



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/generated/azure_mgmt_network/network_management_client.rb', line 183

def check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  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'
  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 || {})
  }

  request_url = @base_url || self.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    self.credentials.sign_request(req) unless self.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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][a-z0-9-]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.



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

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