Class: Azure::ApiManagement::Mgmt::V2018_01_01::Notification

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Notification

Creates and initializes a new instance of the Notification class.

Parameters:

  • client

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, service_name, notification_name, if_match: nil, custom_headers: nil) ⇒ NotificationContract

Updates an Notification.

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

  • notification_name (NotificationName)

    Notification Name Identifier.

  • 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:

  • (NotificationContract)

    operation results.



259
260
261
262
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 259

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

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

Updates an Notification.

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

  • notification_name (NotificationName)

    Notification Name Identifier.

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



302
303
304
305
306
307
308
309
310
311
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
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 302

def create_or_update_async(resource_group_name, service_name, notification_name, 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, '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['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}/notifications/{notificationName}'

  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(: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 == 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::NotificationContract.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, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an Notification.

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

  • notification_name (NotificationName)

    Notification Name Identifier.

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



281
282
283
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 281

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

#get(resource_group_name, service_name, notification_name, custom_headers: nil) ⇒ NotificationContract

Gets the details of the Notification specified by its identifier.

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:

  • (NotificationContract)

    operation results.



144
145
146
147
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 144

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

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

Gets the details of the Notification specified by its identifier.

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.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 183

def get_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}'

  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_01_01::Models::NotificationContract.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_with_http_info(resource_group_name, service_name, notification_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of the Notification specified by its identifier.

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.



164
165
166
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 164

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

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

Lists a collection of properties defined within a 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.

  • 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<NotificationContract>)

    operation results.



36
37
38
39
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 36

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

#list_by_service_as_lazy(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ NotificationCollection

Lists a collection of properties defined within a service instance.

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.

  • 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:

  • (NotificationCollection)

    which provide lazy access to pages of the



465
466
467
468
469
470
471
472
473
474
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 465

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

Lists a collection of properties defined within a 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.

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



69
70
71
72
73
74
75
76
77
78
79
80
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
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 69

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

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'$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 MsRestAzure::AzureOperationError.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::NotificationCollection.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) ⇒ NotificationCollection

Lists a collection of properties defined within a service instance.

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:

  • (NotificationCollection)

    operation results.



372
373
374
375
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 372

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 a collection of properties defined within a service instance.

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.



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 401

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 MsRestAzure::AzureOperationError.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::NotificationCollection.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 a collection of properties defined within a service instance.

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.



387
388
389
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 387

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

Lists a collection of properties defined within a 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.

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



53
54
55
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/notification.rb', line 53

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