Class: Azure::ApiManagement::Mgmt::V2019_01_01::ApiDiagnostic

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApiDiagnostic

Creates and initializes a new instance of the ApiDiagnostic class.

Parameters:

  • client

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientApiManagementClient (readonly)

Returns reference to the ApiManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match: nil, custom_headers: nil) ⇒ DiagnosticContract

Creates a new Diagnostic for an API or updates an existing one.

Management service instance. current API Management service instance. entity, but required when updating an entity. 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

  • parameters (DiagnosticContract)

    Create parameters.

  • if_match (String) (defaults to: nil)

    ETag of the Entity. Not required when creating an

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

    A hash of custom headers that

Returns:

  • (DiagnosticContract)

    operation results.



394
395
396
397
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 394

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

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

Creates a new Diagnostic for an API or updates an existing one.

Management service instance. current API Management service instance. entity, but required when updating an entity. 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

  • parameters (DiagnosticContract)

    Create parameters.

  • if_match (String) (defaults to: nil)

    ETag of the Entity. Not required when creating an

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
475
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
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 437

def create_or_update_async(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match: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, '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': '^[^*#&+:<>?]+$'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, 'parameters is nil' if parameters.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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ApiManagement::Mgmt::V2019_01_01::Models::DiagnosticContract.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}'

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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::V2019_01_01::Models::DiagnosticContract.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::V2019_01_01::Models::DiagnosticContract.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, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new Diagnostic for an API or updates an existing one.

Management service instance. current API Management service instance. entity, but required when updating an entity. 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

  • parameters (DiagnosticContract)

    Create parameters.

  • if_match (String) (defaults to: nil)

    ETag of the Entity. Not required when creating an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



416
417
418
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 416

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

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

Deletes the specified Diagnostic from an API.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • if_match (String)

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that



664
665
666
667
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 664

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

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

Deletes the specified Diagnostic from an API.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • if_match (String)

    ETag of the Entity. ETag should match the current

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 707

def delete_async(resource_group_name, service_name, api_id, diagnostic_id, if_match, 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, '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': '^[^*#&+:<>?]+$'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, 'if_match is nil' if if_match.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['If-Match'] = if_match unless if_match.nil?
  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}'

  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,'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, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified Diagnostic from an API.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • if_match (String)

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



686
687
688
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 686

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

#get(resource_group_name, service_name, api_id, diagnostic_id, custom_headers: nil) ⇒ DiagnosticContract

Gets the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

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

    A hash of custom headers that

Returns:

  • (DiagnosticContract)

    operation results.



275
276
277
278
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 275

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

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

Gets the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
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
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 312

def get_async(resource_group_name, service_name, api_id, diagnostic_id, 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, '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': '^[^*#&+:<>?]+$'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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}'

  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,'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(: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::V2019_01_01::Models::DiagnosticContract.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

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

Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

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

    A hash of custom headers that



167
168
169
170
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 167

def get_entity_tag(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:nil)
  response = get_entity_tag_async(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:custom_headers).value!
  nil
end

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

Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 206

def get_entity_tag_async(resource_group_name, service_name, api_id, diagnostic_id, 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, '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': '^[^*#&+:<>?]+$'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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}'

  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,'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 == 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?

    result
  end

  promise.execute
end

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

Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

  • 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-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 187

def get_entity_tag_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:nil)
  get_entity_tag_async(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:custom_headers).value!
end

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

Gets the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API 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

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



294
295
296
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 294

def get_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:nil)
  get_async(resource_group_name, service_name, api_id, diagnostic_id, custom_headers:custom_headers).value!
end

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

Lists all diagnostics of an API.

Management service instance. operators | Supported functions |</br>|————-|————-|————-|————-|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> 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

  • filter (String) (defaults to: nil)

    | Field | Usage | 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<DiagnosticContract>)

    operation results.



43
44
45
46
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 43

def list_by_service(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  first_page = list_by_service_as_lazy(resource_group_name, service_name, api_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, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ DiagnosticCollection

Lists all diagnostics of an API.

Management service instance. operators | Supported functions |</br>|————-|————-|————-|————-|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> 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

  • filter (String) (defaults to: nil)

    | Field | Usage | 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:

  • (DiagnosticCollection)

    which provide lazy access to pages of the



874
875
876
877
878
879
880
881
882
883
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 874

def list_by_service_as_lazy(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  response = list_by_service_async(resource_group_name, service_name, api_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, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all diagnostics of an API.

Management service instance. operators | Supported functions |</br>|————-|————-|————-|————-|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> 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

  • filter (String) (defaults to: nil)

    | Field | Usage | 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.



90
91
92
93
94
95
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
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 90

def list_by_service_async(resource_group_name, service_name, api_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, "'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
  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'

  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},
      query_params: {'$filter' => filter,'$top' => top,'$skip' => skip,'api-version' => @client.api_version},
      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::V2019_01_01::Models::DiagnosticCollection.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) ⇒ DiagnosticCollection

Lists all diagnostics 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:

  • (DiagnosticCollection)

    operation results.



774
775
776
777
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 774

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 diagnostics 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.



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 803

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::V2019_01_01::Models::DiagnosticCollection.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 diagnostics 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.



789
790
791
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 789

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, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all diagnostics of an API.

Management service instance. operators | Supported functions |</br>|————-|————-|————-|————-|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br> 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

  • filter (String) (defaults to: nil)

    | Field | Usage | 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.



67
68
69
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 67

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

#update(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers: nil) ⇒ Object

Updates the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • parameters (DiagnosticContract)

    Diagnostic Update parameters.

  • if_match (String)

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that



538
539
540
541
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 538

def update(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers:nil)
  response = update_async(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers:custom_headers).value!
  nil
end

#update_async(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise

Updates the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • parameters (DiagnosticContract)

    Diagnostic Update parameters.

  • if_match (String)

    ETag of the Entity. ETag should match the current

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 583

def update_async(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, 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, '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': '^[^*#&+:<>?]+$'" if !diagnostic_id.nil? && diagnostic_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, 'if_match is nil' if if_match.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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::ApiManagement::Mgmt::V2019_01_01::Models::DiagnosticContract.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}'

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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
      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

#update_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates the details of the Diagnostic for an API specified by its identifier.

Management service instance. current API Management service instance. entity state from the header response of the GET request or it should be * for unconditional update. 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

  • parameters (DiagnosticContract)

    Diagnostic Update parameters.

  • if_match (String)

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



561
562
563
# File 'lib/2019-01-01/generated/azure_mgmt_api_management/api_diagnostic.rb', line 561

def update_with_http_info(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers:nil)
  update_async(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers:custom_headers).value!
end