Class: Azure::ApiManagement::Mgmt::V2018_06_01_preview::UserSubscription

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ UserSubscription

Creates and initializes a new instance of the UserSubscription class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list(resource_group_name, service_name, user_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<SubscriptionContract>

Lists the collection of subscriptions of the specified user.

Management service instance. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |ownerId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |scope | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

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.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    | Field | Supported operators | Supported

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

    Number of records to return.

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

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (Array<SubscriptionContract>) —

    operation results.



56
57
58
59
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 56

def list(resource_group_name, service_name, user_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, service_name, user_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, service_name, user_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ SubscriptionCollection

Lists the collection of subscriptions of the specified user.

Management service instance. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |ownerId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |scope | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

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.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    | Field | Supported operators | Supported

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

    Number of records to return.

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

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (SubscriptionCollection) —

    which provide lazy access to pages of the



316
317
318
319
320
321
322
323
324
325
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 316

def list_as_lazy(resource_group_name, service_name, user_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  response = list_async(resource_group_name, service_name, user_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_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, service_name, user_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the collection of subscriptions of the specified user.

Management service instance. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |ownerId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |scope | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

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.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    | Field | Supported operators | Supported

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

    Number of records to return.

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

    Number of records to skip.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 129

def list_async(resource_group_name, service_name, user_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, '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, "'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}/users/{userId}/subscriptions'

  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,'userId' => user_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::V2018_06_01_preview::Models::SubscriptionCollection.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_next(next_page_link, custom_headers: nil) ⇒ SubscriptionCollection

Lists the collection of subscriptions of the specified user.

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:

  • (SubscriptionCollection) —

    operation results.



203
204
205
206
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 203

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

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

Lists the collection of subscriptions of the specified user.

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.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 232

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ApiManagement::Mgmt::V2018_06_01_preview::Models::SubscriptionCollection.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the collection of subscriptions of the specified user.

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.



218
219
220
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 218

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, service_name, user_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the collection of subscriptions of the specified user.

Management service instance. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |ownerId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |scope | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

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.

  • user_id (String) —

    User identifier. Must be unique in the current API

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

    | Field | Supported operators | Supported

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

    Number of records to return.

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

    Number of records to skip.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



93
94
95
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/user_subscription.rb', line 93

def list_with_http_info(resource_group_name, service_name, user_id, filter:nil, top:nil, skip:nil, custom_headers:nil)
  list_async(resource_group_name, service_name, user_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value!
end