Class: Azure::ApiManagement::Mgmt::V2018_01_01::ProductApi
- Inherits:
-
Object
- Object
- Azure::ApiManagement::Mgmt::V2018_01_01::ProductApi
- Includes:
- MsRestAzure
- Defined in:
- lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb
Overview
ApiManagement Client
Instance Attribute Summary collapse
-
#client ⇒ ApiManagementClient
readonly
Reference to the ApiManagementClient.
Instance Method Summary collapse
-
#check_entity_exists(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Boolean
Checks that API entity specified by identifier is associated with the Product entity.
-
#check_entity_exists_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Checks that API entity specified by identifier is associated with the Product entity.
-
#check_entity_exists_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Checks that API entity specified by identifier is associated with the Product entity.
-
#create_or_update(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ ApiContract
Adds an API to the specified product.
-
#create_or_update_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Adds an API to the specified product.
-
#create_or_update_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Adds an API to the specified product.
-
#delete(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Object
Deletes the specified API from the specified product.
-
#delete_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified API from the specified product.
-
#delete_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified API from the specified product.
-
#initialize(client) ⇒ ProductApi
constructor
Creates and initializes a new instance of the ProductApi class.
-
#list_by_product(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<ApiContract>
Lists a collection of the APIs associated with a product.
-
#list_by_product_as_lazy(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ ApiCollection
Lists a collection of the APIs associated with a product.
-
#list_by_product_async(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of the APIs associated with a product.
-
#list_by_product_next(next_page_link, custom_headers: nil) ⇒ ApiCollection
Lists a collection of the APIs associated with a product.
-
#list_by_product_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of the APIs associated with a product.
-
#list_by_product_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of the APIs associated with a product.
-
#list_by_product_with_http_info(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of the APIs associated with a product.
Constructor Details
#initialize(client) ⇒ ProductApi
Creates and initializes a new instance of the ProductApi class.
17 18 19 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ApiManagementClient (readonly)
22 23 24 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 22 def client @client end |
Instance Method Details
#check_entity_exists(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Boolean
Checks that API entity specified by identifier is associated with the Product entity.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
197 198 199 200 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 197 def check_entity_exists(resource_group_name, service_name, product_id, api_id, custom_headers:nil) response = check_entity_exists_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#check_entity_exists_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Checks that API entity specified by identifier is associated with the Product entity.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. to the HTTP request.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 238 def check_entity_exists_async(resource_group_name, service_name, product_id, api_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, 'product_id is nil' if product_id.nil? fail ArgumentError, "'product_id' should satisfy the constraint - 'MaxLength': '80'" if !product_id.nil? && product_id.length > 80 fail ArgumentError, "'product_id' should satisfy the constraint - 'MinLength': '1'" if !product_id.nil? && product_id.length < 1 fail ArgumentError, "'product_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !product_id.nil? && product_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil? fail ArgumentError, 'api_id is nil' if api_id.nil? fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256 fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1 fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_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}/products/{productId}/apis/{apiId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'productId' => product_id,'apiId' => api_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, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 204 || status_code == 404 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.body = (status_code == 204) result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? result end promise.execute end |
#check_entity_exists_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Checks that API entity specified by identifier is associated with the Product entity.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
218 219 220 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 218 def check_entity_exists_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers:nil) check_entity_exists_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! end |
#create_or_update(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ ApiContract
Adds an API to the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
310 311 312 313 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 310 def create_or_update(resource_group_name, service_name, product_id, api_id, custom_headers:nil) response = create_or_update_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Adds an API to the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. to the HTTP request.
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 349 def create_or_update_async(resource_group_name, service_name, product_id, api_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, 'product_id is nil' if product_id.nil? fail ArgumentError, "'product_id' should satisfy the constraint - 'MaxLength': '80'" if !product_id.nil? && product_id.length > 80 fail ArgumentError, "'product_id' should satisfy the constraint - 'MinLength': '1'" if !product_id.nil? && product_id.length < 1 fail ArgumentError, "'product_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !product_id.nil? && product_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil? fail ArgumentError, 'api_id is nil' if api_id.nil? fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256 fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1 fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_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}/products/{productId}/apis/{apiId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'productId' => product_id,'apiId' => api_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, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 201 || status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::ApiContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_or_update_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Adds an API to the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
330 331 332 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 330 def create_or_update_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers:nil) create_or_update_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! end |
#delete(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Object
Deletes the specified API from the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
439 440 441 442 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 439 def delete(resource_group_name, service_name, product_id, api_id, custom_headers:nil) response = delete_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, service_name, product_id, api_id, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified API from the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. to the HTTP request.
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 478 def delete_async(resource_group_name, service_name, product_id, api_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, 'product_id is nil' if product_id.nil? fail ArgumentError, "'product_id' should satisfy the constraint - 'MaxLength': '80'" if !product_id.nil? && product_id.length > 80 fail ArgumentError, "'product_id' should satisfy the constraint - 'MinLength': '1'" if !product_id.nil? && product_id.length < 1 fail ArgumentError, "'product_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !product_id.nil? && product_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil? fail ArgumentError, 'api_id is nil' if api_id.nil? fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256 fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1 fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_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}/products/{productId}/apis/{apiId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'productId' => product_id,'apiId' => api_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, ) 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, product_id, api_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified API from the specified product.
API Management service instance. API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. will be added to the HTTP request.
459 460 461 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 459 def delete_with_http_info(resource_group_name, service_name, product_id, api_id, custom_headers:nil) delete_async(resource_group_name, service_name, product_id, api_id, custom_headers:custom_headers).value! end |
#list_by_product(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<ApiContract>
Lists a collection of the APIs associated with a product.
API Management service instance. functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
will be added to the HTTP request.
52 53 54 55 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 52 def list_by_product(resource_group_name, service_name, product_id, filter:nil, top:nil, skip:nil, custom_headers:nil) first_page = list_by_product_as_lazy(resource_group_name, service_name, product_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_product_as_lazy(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ ApiCollection
Lists a collection of the APIs associated with a product.
API Management service instance. functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
will be added to the HTTP request.
652 653 654 655 656 657 658 659 660 661 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 652 def list_by_product_as_lazy(resource_group_name, service_name, product_id, filter:nil, top:nil, skip:nil, custom_headers:nil) response = list_by_product_async(resource_group_name, service_name, product_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_product_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_by_product_async(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of the APIs associated with a product.
API Management service instance. functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
to the HTTP request.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 117 def list_by_product_async(resource_group_name, service_name, product_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, 'product_id is nil' if product_id.nil? fail ArgumentError, "'product_id' should satisfy the constraint - 'MaxLength': '80'" if !product_id.nil? && product_id.length > 80 fail ArgumentError, "'product_id' should satisfy the constraint - 'MinLength': '1'" if !product_id.nil? && product_id.length < 1 fail ArgumentError, "'product_id' should satisfy the constraint - 'Pattern': '(^[\w]+$)|(^[\w][\w\-]+[\w]$)'" if !product_id.nil? && product_id.match(Regexp.new('^(^[\w]+$)|(^[\w][\w\-]+[\w]$)$')).nil? fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0 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}/products/{productId}/apis' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'productId' => product_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, ) 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::ApiCollection.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_product_next(next_page_link, custom_headers: nil) ⇒ ApiCollection
Lists a collection of the APIs associated with a product.
to List operation. will be added to the HTTP request.
544 545 546 547 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 544 def list_by_product_next(next_page_link, custom_headers:nil) response = list_by_product_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_product_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of the APIs associated with a product.
to List operation. to the HTTP request.
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 573 def list_by_product_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 = { 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, ) 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::ApiCollection.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_product_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of the APIs associated with a product.
to List operation. will be added to the HTTP request.
559 560 561 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 559 def list_by_product_next_with_http_info(next_page_link, custom_headers:nil) list_by_product_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_by_product_with_http_info(resource_group_name, service_name, product_id, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of the APIs associated with a product.
API Management service instance. functions | |————-|————————|———————————————| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
will be added to the HTTP request.
85 86 87 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/product_api.rb', line 85 def list_by_product_with_http_info(resource_group_name, service_name, product_id, filter:nil, top:nil, skip:nil, custom_headers:nil) list_by_product_async(resource_group_name, service_name, product_id, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value! end |