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

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



103
104
105
106
107
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
 
# File 'lib/azure_mgmt_network/network_management_client.rb', line 103

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)
  @usages = Usages.new(self)
  @virtual_network_gateway_connections = VirtualNetworkGatewayConnections.new(self)
  @virtual_network_gateways = VirtualNetworkGateways.new(self)
  @virtual_networks = VirtualNetworks.new(self)
  @api_version = '2015-06-15'
  @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/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/azure_mgmt_network/network_management_client.rb', line 26

def api_version
  @api_version
end

#application_gateways ⇒ Object (readonly)

Returns application_gateways.

Returns:

  • application_gateways



44
45
46
 
# File 'lib/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/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/azure_mgmt_network/network_management_client.rb', line 18

def credentials
  @credentials
end

#express_route_circuit_authorizations ⇒ Object (readonly)

Returns express_route_circuit_authorizations.

Returns:

  • express_route_circuit_authorizations



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

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_peerings ⇒ Object (readonly)

Returns express_route_circuit_peerings.

Returns:

  • express_route_circuit_peerings



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

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuits ⇒ Object (readonly)

Returns express_route_circuits.

Returns:

  • express_route_circuits



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

def express_route_circuits
  @express_route_circuits
end

#express_route_service_providers ⇒ Object (readonly)

Returns express_route_service_providers.

Returns:

  • express_route_service_providers



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

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/azure_mgmt_network/network_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#load_balancers ⇒ Object (readonly)

Returns load_balancers.

Returns:

  • load_balancers



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

def load_balancers
  @load_balancers
end

#local_network_gateways ⇒ Object (readonly)

Returns local_network_gateways.

Returns:

  • local_network_gateways



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

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/azure_mgmt_network/network_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#network_interfaces ⇒ Object (readonly)

Returns network_interfaces.

Returns:

  • network_interfaces



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

def network_interfaces
  @network_interfaces
end

#network_security_groups ⇒ Object (readonly)

Returns network_security_groups.

Returns:

  • network_security_groups



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

def network_security_groups
  @network_security_groups
end

#public_ipaddresses ⇒ Object (readonly)

Returns public_ipaddresses.

Returns:

  • public_ipaddresses



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

def public_ipaddresses
  @public_ipaddresses
end

#route_tables ⇒ Object (readonly)

Returns route_tables.

Returns:

  • route_tables



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

def route_tables
  @route_tables
end

#routes ⇒ Object (readonly)

Returns routes.

Returns:

  • routes



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

def routes
  @routes
end

#security_rules ⇒ Object (readonly)

Returns security_rules.

Returns:

  • security_rules



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

def security_rules
  @security_rules
end

#subnets ⇒ Object (readonly)

Returns subnets.

Returns:

  • subnets



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

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

def subscription_id
  @subscription_id
end

#usages ⇒ Object (readonly)

Returns usages.

Returns:

  • usages



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

def usages
  @usages
end

#virtual_network_gateway_connections ⇒ Object (readonly)

Returns virtual_network_gateway_connections.

Returns:

  • virtual_network_gateway_connections



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

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gateways ⇒ Object (readonly)

Returns virtual_network_gateways.

Returns:

  • virtual_network_gateways



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

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_networks ⇒ Object (readonly)

Returns virtual_networks.

Returns:

  • virtual_networks



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

def virtual_networks
  @virtual_networks
end

Instance Method Details

#check_dns_name_availability(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$. applied to HTTP request.

response.

Parameters:

  • location (String) —

    The location of the domain name

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

    The domain name to be verified. It must

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
 
# File 'lib/azure_mgmt_network/network_management_client.rb', line 147

def check_dns_name_availability(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 = MsRest::HttpOperationRequest.new(@base_url || self.base_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)
        unless parsed_response.nil?
          parsed_response = DnsNameAvailabilityResult.deserialize_object(parsed_response)
        end
        result.body = 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