Class: Azure::ARM::CDN::CdnManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/generated/azure_mgmt_cdn/cdn_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) ⇒ CdnManagementClient

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 56

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

  @profiles = Profiles.new(self)
  @endpoints = Endpoints.new(self)
  @origins = Origins.new(self)
  @custom_domains = CustomDomains.new(self)
  @api_version = '2016-10-02'
  @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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



28
29
30
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Current version is 2016-10-02.

Returns:

  • (String) —

    Version of the API to be used with the client request.



25
26
27
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 25

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/generated/azure_mgmt_cdn/cdn_management_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/generated/azure_mgmt_cdn/cdn_management_client.rb', line 18

def credentials
  @credentials
end

#custom_domains ⇒ CustomDomains (readonly)

Returns custom_domains.

Returns:



48
49
50
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 48

def custom_domains
  @custom_domains
end

#endpoints ⇒ Endpoints (readonly)

Returns endpoints.

Returns:



42
43
44
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 42

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



36
37
38
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 36

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



32
33
34
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#origins ⇒ Origins (readonly)

Returns origins.

Returns:



45
46
47
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 45

def origins
  @origins
end

#profiles ⇒ Profiles (readonly)

Returns profiles.

Returns:



39
40
41
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 39

def profiles
  @profiles
end

#subscription_id ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



21
22
23
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 21

def subscription_id
  @subscription_id
end

Instance Method Details

#check_name_availability(check_name_availability_input, custom_headers = nil) ⇒ CheckNameAvailabilityOutput

Check the availability of a resource name without creating the resource. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

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

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityOutput) —

    operation results.



142
143
144
145
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 142

def check_name_availability(check_name_availability_input, custom_headers = nil)
  response = check_name_availability_async(check_name_availability_input, custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_async(check_name_availability_input, custom_headers = nil) ⇒ Concurrent::Promise

Check the availability of a resource name without creating the resource. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 175

def check_name_availability_async(check_name_availability_input, custom_headers = nil)
  fail ArgumentError, 'check_name_availability_input is nil' if check_name_availability_input.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

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

  # Serialize Request
  request_mapper = CheckNameAvailabilityInput.mapper()
  request_content = self.serialize(request_mapper,  check_name_availability_input, 'check_name_availability_input')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/providers/Microsoft.Cdn/checkNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = CheckNameAvailabilityOutput.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_name_availability_with_http_info(check_name_availability_input, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Check the availability of a resource name without creating the resource. This is needed for resources where name is globally unique, such as a CDN endpoint.

check. will be added to the HTTP request.

Parameters:

  • check_name_availability_input (CheckNameAvailabilityInput) —

    Input to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 159

def check_name_availability_with_http_info(check_name_availability_input, custom_headers = nil)
  check_name_availability_async(check_name_availability_input, custom_headers).value!
end

#list_operations(custom_headers = nil) ⇒ Array<Operation>

Lists all of the available CDN REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<Operation>) —

    operation results.



241
242
243
244
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 241

def list_operations(custom_headers = nil)
  first_page = list_operations_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_operations_as_lazy(custom_headers = nil) ⇒ OperationListResult

Lists all of the available CDN REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (OperationListResult) —

    operation results.



409
410
411
412
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 409

def list_operations_as_lazy(custom_headers = nil)
  first_page = list_operations_as_lazy_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_operations_as_lazy_async(custom_headers = nil) ⇒ Concurrent::Promise

Lists all of the available CDN REST API operations.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 434

def list_operations_as_lazy_async(custom_headers = nil)


  request_headers = {}
  path_template = '/providers/Microsoft.Cdn/operations'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = OperationListResult.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

#list_operations_as_lazy_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available CDN REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



422
423
424
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 422

def list_operations_as_lazy_with_http_info(custom_headers = nil)
  list_operations_as_lazy_async(custom_headers).value!
end

#list_operations_async(custom_headers = nil) ⇒ Concurrent::Promise

Lists all of the available CDN REST API operations.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 266

def list_operations_async(custom_headers = nil)
  fail ArgumentError, 'api_version is nil' if api_version.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 = '/providers/Microsoft.Cdn/operations'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = OperationListResult.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

#list_operations_next(next_page_link, custom_headers = nil) ⇒ OperationListResult

Lists all of the available CDN REST API operations.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (OperationListResult) —

    operation results.



324
325
326
327
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 324

def list_operations_next(next_page_link, custom_headers = nil)
  response = list_operations_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_operations_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Lists all of the available CDN REST API operations.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
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
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 353

def list_operations_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = OperationListResult.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

#list_operations_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available CDN REST API operations.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



339
340
341
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 339

def list_operations_next_with_http_info(next_page_link, custom_headers = nil)
  list_operations_next_async(next_page_link, custom_headers).value!
end

#list_operations_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available CDN REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



254
255
256
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 254

def list_operations_with_http_info(custom_headers = nil)
  list_operations_async(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.



91
92
93
94
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 91

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.



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 116

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

  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.



103
104
105
106
107
 
# File 'lib/generated/azure_mgmt_cdn/cdn_management_client.rb', line 103

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