Class: Azure::Peering::Mgmt::V2019_08_01_preview::PeeringClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_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) ⇒ PeeringClient

Creates initializes a new instance of the PeeringClient 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.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 74

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

  @legacy_peerings = LegacyPeerings.new(self)
  @operations = Operations.new(self)
  @peer_asns = PeerAsns.new(self)
  @peering_locations = PeeringLocations.new(self)
  @peerings = Peerings.new(self)
  @peering_service_locations = PeeringServiceLocations.new(self)
  @peering_service_prefixes = PeeringServicePrefixes.new(self)
  @prefixes = Prefixes.new(self)
  @peering_service_providers = PeeringServiceProviders.new(self)
  @peering_services = PeeringServices.new(self)
  @api_version = '2019-08-01-preview'
  @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.



27
28
29
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 27

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns The client API version.

Returns:

  • (String) —

    The client API version.



24
25
26
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 24

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 15

def base_url
  @base_url
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/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 18

def credentials
  @credentials
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



36
37
38
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#legacy_peerings ⇒ LegacyPeerings (readonly)

Returns legacy_peerings.

Returns:



39
40
41
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 39

def legacy_peerings
  @legacy_peerings
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



42
43
44
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 42

def operations
  @operations
end

#peer_asns ⇒ PeerAsns (readonly)

Returns peer_asns.

Returns:



45
46
47
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 45

def peer_asns
  @peer_asns
end

#peering_locations ⇒ PeeringLocations (readonly)

Returns peering_locations.

Returns:



48
49
50
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 48

def peering_locations
  @peering_locations
end

#peering_service_locations ⇒ PeeringServiceLocations (readonly)

Returns peering_service_locations.

Returns:



54
55
56
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 54

def peering_service_locations
  @peering_service_locations
end

#peering_service_prefixes ⇒ PeeringServicePrefixes (readonly)

Returns peering_service_prefixes.

Returns:



57
58
59
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 57

def peering_service_prefixes
  @peering_service_prefixes
end

#peering_service_providers ⇒ PeeringServiceProviders (readonly)

Returns peering_service_providers.

Returns:



63
64
65
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 63

def peering_service_providers
  @peering_service_providers
end

#peering_services ⇒ PeeringServices (readonly)

Returns peering_services.

Returns:



66
67
68
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 66

def peering_services
  @peering_services
end

#peerings ⇒ Peerings (readonly)

Returns peerings.

Returns:



51
52
53
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 51

def peerings
  @peerings
end

#prefixes ⇒ Prefixes (readonly)

Returns prefixes.

Returns:



60
61
62
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 60

def prefixes
  @prefixes
end

#subscription_id ⇒ String

Returns The Azure subscription ID.

Returns:

  • (String) —

    The Azure subscription ID.



21
22
23
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 21

def subscription_id
  @subscription_id
end

Instance Method Details

#check_service_provider_availability(check_service_provider_availability_input, custom_headers: nil) ⇒ enum

Checks if the peering service provider is present within 1000 miles of customer’s location

CheckServiceProviderAvailabilityInput

The

CheckServiceProviderAvailabilityInput indicating customer location and service provider. will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (enum) —

    operation results.



169
170
171
172
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 169

def check_service_provider_availability(check_service_provider_availability_input, custom_headers:nil)
  response = check_service_provider_availability_async(check_service_provider_availability_input, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_service_provider_availability_async(check_service_provider_availability_input, custom_headers: nil) ⇒ Concurrent::Promise

Checks if the peering service provider is present within 1000 miles of customer’s location

CheckServiceProviderAvailabilityInput

The

CheckServiceProviderAvailabilityInput indicating customer location and service provider. to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
263
264
265
266
267
268
269
270
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 204

def check_service_provider_availability_async(check_service_provider_availability_input, custom_headers:nil)
  fail ArgumentError, 'check_service_provider_availability_input is nil' if check_service_provider_availability_input.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'api_version is nil' if api_version.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?

  # Serialize Request
  request_mapper = Azure::Peering::Mgmt::V2019_08_01_preview::Models::CheckServiceProviderAvailabilityInput.mapper()
  request_content = self.serialize(request_mapper,  check_service_provider_availability_input)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Peering/CheckServiceProviderAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, 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 MsRest::HttpOperationError.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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        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_service_provider_availability_with_http_info(check_service_provider_availability_input, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks if the peering service provider is present within 1000 miles of customer’s location

CheckServiceProviderAvailabilityInput

The

CheckServiceProviderAvailabilityInput indicating customer location and service provider. will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



187
188
189
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 187

def check_service_provider_availability_with_http_info(check_service_provider_availability_input, custom_headers:nil)
  check_service_provider_availability_async(check_service_provider_availability_input, 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.



114
115
116
117
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 114

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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 139

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.



126
127
128
129
130
 
# File 'lib/2019-08-01-preview/generated/azure_mgmt_peering/peering_client.rb', line 126

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