Class: Azure::ApiManagement::Mgmt::V2018_06_01_preview::NotificationRecipientUser

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ NotificationRecipientUser

Creates and initializes a new instance of the NotificationRecipientUser class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.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-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 22

def client
  @client
end

Instance Method Details

#check_entity_exists(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ Object

Determine if the Notification Recipient User is subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    A hash of custom headers that



157
158
159
160
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 157

def check_entity_exists(resource_group_name, service_name, notification_name, user_id, custom_headers:nil)
  response = check_entity_exists_async(resource_group_name, service_name, notification_name, user_id, custom_headers:custom_headers).value!
  nil
end

#check_entity_exists_async(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise

Determine if the Notification Recipient User is subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 202

def check_entity_exists_async(resource_group_name, service_name, notification_name, user_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, 'notification_name is nil' if notification_name.nil?
  fail ArgumentError, 'user_id is nil' if user_id.nil?
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MaxLength': '80'" if !user_id.nil? && user_id.length > 80
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MinLength': '1'" if !user_id.nil? && user_id.length < 1
  fail ArgumentError, "'user_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !user_id.nil? && user_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}/notifications/{notificationName}/recipientUsers/{userId}'

  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,'notificationName' => notification_name,'userId' => user_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 == 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

#check_entity_exists_with_http_info(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Determine if the Notification Recipient User is subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



180
181
182
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 180

def check_entity_exists_with_http_info(resource_group_name, service_name, notification_name, user_id, custom_headers:nil)
  check_entity_exists_async(resource_group_name, service_name, notification_name, user_id, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ RecipientUserContract

Adds the API Management User to the list of Recipients for the Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    A hash of custom headers that

Returns:

  • (RecipientUserContract) —

    operation results.



272
273
274
275
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 272

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

#create_or_update_async(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise

Adds the API Management User to the list of Recipients for the Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 315

def create_or_update_async(resource_group_name, service_name, notification_name, user_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, 'notification_name is nil' if notification_name.nil?
  fail ArgumentError, 'user_id is nil' if user_id.nil?
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MaxLength': '80'" if !user_id.nil? && user_id.length > 80
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MinLength': '1'" if !user_id.nil? && user_id.length < 1
  fail ArgumentError, "'user_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !user_id.nil? && user_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}/notifications/{notificationName}/recipientUsers/{userId}'

  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,'notificationName' => notification_name,'userId' => user_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(: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_06_01_preview::Models::RecipientUserContract.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_06_01_preview::Models::RecipientUserContract.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, notification_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Adds the API Management User to the list of Recipients for the Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

  • 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/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 294

def create_or_update_with_http_info(resource_group_name, service_name, notification_name, user_id, custom_headers:nil)
  create_or_update_async(resource_group_name, service_name, notification_name, user_id, custom_headers:custom_headers).value!
end

#delete(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ Object

Removes the API Management user from the list of Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    A hash of custom headers that



404
405
406
407
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 404

def delete(resource_group_name, service_name, notification_name, user_id, custom_headers:nil)
  response = delete_async(resource_group_name, service_name, notification_name, user_id, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, service_name, notification_name, user_id, custom_headers: nil) ⇒ Concurrent::Promise

Removes the API Management user from the list of Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 447

def delete_async(resource_group_name, service_name, notification_name, user_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, 'notification_name is nil' if notification_name.nil?
  fail ArgumentError, 'user_id is nil' if user_id.nil?
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MaxLength': '80'" if !user_id.nil? && user_id.length > 80
  fail ArgumentError, "'user_id' should satisfy the constraint - 'MinLength': '1'" if !user_id.nil? && user_id.length < 1
  fail ArgumentError, "'user_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !user_id.nil? && user_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}/notifications/{notificationName}/recipientUsers/{userId}'

  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,'notificationName' => notification_name,'userId' => user_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, notification_name, user_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Removes the API Management user from the list of Notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



426
427
428
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 426

def delete_with_http_info(resource_group_name, service_name, notification_name, user_id, custom_headers:nil)
  delete_async(resource_group_name, service_name, notification_name, user_id, custom_headers:custom_headers).value!
end

#list_by_notification(resource_group_name, service_name, notification_name, custom_headers: nil) ⇒ RecipientUserCollection

Gets the list of the Notification Recipient User subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

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

    A hash of custom headers that

Returns:

  • (RecipientUserCollection) —

    operation results.



40
41
42
43
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 40

def list_by_notification(resource_group_name, service_name, notification_name, custom_headers:nil)
  response = list_by_notification_async(resource_group_name, service_name, notification_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_notification_async(resource_group_name, service_name, notification_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the list of the Notification Recipient User subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



81
82
83
84
85
86
87
88
89
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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 81

def list_by_notification_async(resource_group_name, service_name, notification_name, 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, 'notification_name is nil' if notification_name.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}/notifications/{notificationName}/recipientUsers'

  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,'notificationName' => notification_name,'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::V2018_06_01_preview::Models::RecipientUserCollection.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_notification_with_http_info(resource_group_name, service_name, notification_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the list of the Notification Recipient User subscribed to the notification.

Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’ 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.

  • notification_name (NotificationName) —

    Notification Name Identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/notification_recipient_user.rb', line 61

def list_by_notification_with_http_info(resource_group_name, service_name, notification_name, custom_headers:nil)
  list_by_notification_async(resource_group_name, service_name, notification_name, custom_headers:custom_headers).value!
end