Class: Azure::ApiManagement::Mgmt::V2018_01_01::ApiDiagnosticLogger

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApiDiagnosticLogger

Creates and initializes a new instance of the ApiDiagnosticLogger class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ApiManagementClient (readonly)

Returns reference to the ApiManagementClient.

Returns:



22
23
24
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 22

def client
  @client
end

Instance Method Details

#check_entity_exists(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ Boolean

Checks that logger entity specified by identifier is associated with the diagnostics entity.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that

Returns:

  • (Boolean) —

    operation results.



181
182
183
184
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 181

def check_entity_exists(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  response = check_entity_exists_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_entity_exists_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ Concurrent::Promise

Checks that logger entity specified by identifier is associated with the diagnostics entity.

Management service instance. current API Management service instance. Management service instance. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 224

def check_entity_exists_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '80'" if !api_id.nil? && api_id.length > 80
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !api_id.nil? && api_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'diagnostic_id is nil' if diagnostic_id.nil?
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MaxLength': '80'" if !diagnostic_id.nil? && diagnostic_id.length > 80
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MinLength': '1'" if !diagnostic_id.nil? && diagnostic_id.length < 1
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'loggerid is nil' if loggerid.nil?
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'MaxLength': '80'" if !loggerid.nil? && loggerid.length > 80
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !loggerid.nil? && loggerid.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'diagnosticId' => diagnostic_id,'loggerid' => loggerid,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:head, 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 == 204 || status_code == 404
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.body = (status_code == 204)
    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?

    result
  end

  promise.execute
end

#check_entity_exists_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks that logger entity specified by identifier is associated with the diagnostics entity.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



203
204
205
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 203

def check_entity_exists_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  check_entity_exists_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ LoggerContract

Attaches a logger to a diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that

Returns:

  • (LoggerContract) —

    operation results.



300
301
302
303
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 300

def create_or_update(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  response = create_or_update_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ Concurrent::Promise

Attaches a logger to a diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



341
342
343
344
345
346
347
348
349
350
351
352
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 341

def create_or_update_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '80'" if !api_id.nil? && api_id.length > 80
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !api_id.nil? && api_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'diagnostic_id is nil' if diagnostic_id.nil?
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MaxLength': '80'" if !diagnostic_id.nil? && diagnostic_id.length > 80
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MinLength': '1'" if !diagnostic_id.nil? && diagnostic_id.length < 1
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'loggerid is nil' if loggerid.nil?
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'MaxLength': '80'" if !loggerid.nil? && loggerid.length > 80
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !loggerid.nil? && loggerid.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'diagnosticId' => diagnostic_id,'loggerid' => loggerid,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 == 201 || 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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::LoggerContract.mapper()
        result.body = @client.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
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::LoggerContract.mapper()
        result.body = @client.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

#create_or_update_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Attaches a logger to a diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



321
322
323
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 321

def create_or_update_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  create_or_update_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
end

#delete(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ Object

Deletes the specified Logger from Diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that



435
436
437
438
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 435

def delete(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  response = delete_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified Logger from Diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 476

def delete_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '80'" if !api_id.nil? && api_id.length > 80
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !api_id.nil? && api_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'diagnostic_id is nil' if diagnostic_id.nil?
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MaxLength': '80'" if !diagnostic_id.nil? && diagnostic_id.length > 80
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MinLength': '1'" if !diagnostic_id.nil? && diagnostic_id.length < 1
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, 'loggerid is nil' if loggerid.nil?
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'MaxLength': '80'" if !loggerid.nil? && loggerid.length > 80
  fail ArgumentError, "'loggerid' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !loggerid.nil? && loggerid.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'diagnosticId' => diagnostic_id,'loggerid' => loggerid,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified Logger from Diagnostic for an API.

Management service instance. current API Management service instance. Management service instance. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

  • loggerid (String) —

    Logger identifier. Must be unique in the API

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



456
457
458
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 456

def delete_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:nil)
  delete_async(resource_group_name, service_name, api_id, diagnostic_id, loggerid, custom_headers:custom_headers).value!
end

#list_by_service(resource_group_name, service_name, api_id, diagnostic_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<LoggerContract>

Lists all loggers associated with the specified Diagnostic of an API.

Management service instance. current API Management service instance. functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

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

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (Array<LoggerContract>) —

    operation results.



45
46
47
48
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 45

def list_by_service(resource_group_name, service_name, api_id, diagnostic_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  first_page = list_by_service_as_lazy(resource_group_name, service_name, api_id, diagnostic_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_service_as_lazy(resource_group_name, service_name, api_id, diagnostic_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ LoggerCollection

Lists all loggers associated with the specified Diagnostic of an API.

Management service instance. current API Management service instance. functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

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

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (LoggerCollection) —

    which provide lazy access to pages of the



647
648
649
650
651
652
653
654
655
656
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 647

def list_by_service_as_lazy(resource_group_name, service_name, api_id, diagnostic_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  response = list_by_service_async(resource_group_name, service_name, api_id, diagnostic_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_service_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_service_async(resource_group_name, service_name, api_id, diagnostic_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all loggers associated with the specified Diagnostic of an API.

Management service instance. current API Management service instance. functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

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

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



96
97
98
99
100
101
102
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 96

def list_by_service_async(resource_group_name, service_name, api_id, diagnostic_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '80'" if !api_id.nil? && api_id.length > 80
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !api_id.nil? && api_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'diagnostic_id is nil' if diagnostic_id.nil?
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MaxLength': '80'" if !diagnostic_id.nil? && diagnostic_id.length > 80
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'MinLength': '1'" if !diagnostic_id.nil? && diagnostic_id.length < 1
  fail ArgumentError, "'diagnostic_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil?
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0


  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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'subscriptionId' => @client.subscription_id,'diagnosticId' => diagnostic_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$top' => top,'$skip' => skip},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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?
    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::ApiManagement::Mgmt::V2018_01_01::Models::LoggerCollection.mapper()
        result.body = @client.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

#list_by_service_next(next_page_link, custom_headers: nil) ⇒ LoggerCollection

Lists all loggers associated with the specified Diagnostic of an API.

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:

  • (LoggerCollection) —

    operation results.



545
546
547
548
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 545

def list_by_service_next(next_page_link, custom_headers:nil)
  response = list_by_service_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all loggers associated with the specified Diagnostic of an API.

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.



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 574

def list_by_service_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.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 = @client.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?
    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::ApiManagement::Mgmt::V2018_01_01::Models::LoggerCollection.mapper()
        result.body = @client.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

#list_by_service_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all loggers associated with the specified Diagnostic of an API.

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.



560
561
562
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 560

def list_by_service_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_service_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_service_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all loggers associated with the specified Diagnostic of an API.

Management service instance. current API Management service instance. functions | |————-|————————|———————————–| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • diagnostic_id (String) —

    Diagnostic identifier. Must be unique in the

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

    | Field | Supported operators | Supported

  • top (Integer) (defaults to: nil) —

    Number of records to return.

  • skip (Integer) (defaults to: nil) —

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



71
72
73
 
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/api_diagnostic_logger.rb', line 71

def list_by_service_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  list_by_service_async(resource_group_name, service_name, api_id, diagnostic_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value!
end