Class: Azure::ApiManagement::Mgmt::V2016_07_07::Subscriptions
- Inherits:
-
Object
- Object
- Azure::ApiManagement::Mgmt::V2016_07_07::Subscriptions
- Includes:
- MsRestAzure
- Defined in:
- lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb
Overview
ApiManagement Client
Instance Attribute Summary collapse
-
#client ⇒ ApiManagementClient
readonly
Reference to the ApiManagementClient.
Instance Method Summary collapse
-
#create_or_update(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ Object
Creates or updates the subscription of specified user to the specified product.
-
#create_or_update_async(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates the subscription of specified user to the specified product.
-
#create_or_update_with_http_info(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates the subscription of specified user to the specified product.
-
#delete(resource_group_name, service_name, sid, if_match, custom_headers: nil) ⇒ Object
Deletes the specified subscription.
-
#delete_async(resource_group_name, service_name, sid, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified subscription.
-
#delete_with_http_info(resource_group_name, service_name, sid, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified subscription.
-
#get(resource_group_name, service_name, sid, custom_headers: nil) ⇒ SubscriptionContract
Gets the specified Subscription entity.
-
#get_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Gets the specified Subscription entity.
-
#get_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the specified Subscription entity.
-
#initialize(client) ⇒ Subscriptions
constructor
Creates and initializes a new instance of the Subscriptions class.
-
#list_by_service(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<SubscriptionContract>
Lists all subscriptions of the API Management service instance.
-
#list_by_service_as_lazy(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ SubscriptionCollection
Lists all subscriptions of the API Management service instance.
-
#list_by_service_async(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists all subscriptions of the API Management service instance.
-
#list_by_service_next(next_page_link, custom_headers: nil) ⇒ SubscriptionCollection
Lists all subscriptions of the API Management service instance.
-
#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists all subscriptions of the API Management service instance.
-
#list_by_service_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all subscriptions of the API Management service instance.
-
#list_by_service_with_http_info(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all subscriptions of the API Management service instance.
-
#regenerate_primary_key(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Object
Regenerates primary key of existing subscription of the API Management service instance.
-
#regenerate_primary_key_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Regenerates primary key of existing subscription of the API Management service instance.
-
#regenerate_primary_key_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Regenerates primary key of existing subscription of the API Management service instance.
-
#regenerate_secondary_key(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Object
Regenerates secondary key of existing subscription of the API Management service instance.
-
#regenerate_secondary_key_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Regenerates secondary key of existing subscription of the API Management service instance.
-
#regenerate_secondary_key_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Regenerates secondary key of existing subscription of the API Management service instance.
-
#update(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ Object
Updates the details of a subscription specified by its identifier.
-
#update_async(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Updates the details of a subscription specified by its identifier.
-
#update_with_http_info(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the details of a subscription specified by its identifier.
Constructor Details
#initialize(client) ⇒ Subscriptions
Creates and initializes a new instance of the Subscriptions class.
17 18 19 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ApiManagementClient (readonly)
Returns reference to the ApiManagementClient.
22 23 24 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 22 def client @client end |
Instance Method Details
#create_or_update(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ Object
Creates or updates the subscription of specified user to the specified product.
will be added to the HTTP request.
287 288 289 290 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 287 def create_or_update(resource_group_name, service_name, sid, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, service_name, sid, parameters, custom_headers:custom_headers).value! nil end |
#create_or_update_async(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates the subscription of specified user to the specified product.
to the HTTP request.
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 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 322 def create_or_update_async(resource_group_name, service_name, sid, parameters, 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, 'sid is nil' if sid.nil? fail ArgumentError, "'sid' should satisfy the constraint - 'MaxLength': '256'" if !sid.nil? && sid.length > 256 fail ArgumentError, "'sid' should satisfy the constraint - 'MinLength': '1'" if !sid.nil? && sid.length < 1 fail ArgumentError, "'sid' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !sid.nil? && sid.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'parameters is nil' if parameters.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::ApiManagement::Mgmt::V2016_07_07::Models::SubscriptionCreateParameters.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}' 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,'sid' => sid,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) 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 == 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 |
#create_or_update_with_http_info(resource_group_name, service_name, sid, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates the subscription of specified user to the specified product.
will be added to the HTTP request.
305 306 307 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 305 def create_or_update_with_http_info(resource_group_name, service_name, sid, parameters, custom_headers:nil) create_or_update_async(resource_group_name, service_name, sid, parameters, custom_headers:custom_headers).value! end |
#delete(resource_group_name, service_name, sid, if_match, custom_headers: nil) ⇒ Object
Deletes the specified subscription.
the current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
507 508 509 510 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 507 def delete(resource_group_name, service_name, sid, if_match, custom_headers:nil) response = delete_async(resource_group_name, service_name, sid, if_match, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, service_name, sid, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified subscription.
the current entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 544 def delete_async(resource_group_name, service_name, sid, if_match, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, 'sid is nil' if sid.nil? fail ArgumentError, 'if_match is nil' if if_match.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['If-Match'] = if_match unless if_match.nil? request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}' 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,'sid' => sid,'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 == 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, sid, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified subscription.
the current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
526 527 528 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 526 def delete_with_http_info(resource_group_name, service_name, sid, if_match, custom_headers:nil) delete_async(resource_group_name, service_name, sid, if_match, custom_headers:custom_headers).value! end |
#get(resource_group_name, service_name, sid, custom_headers: nil) ⇒ SubscriptionContract
Gets the specified Subscription entity.
will be added to the HTTP request.
185 186 187 188 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 185 def get(resource_group_name, service_name, sid, custom_headers:nil) response = get_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Gets the specified Subscription entity.
to the HTTP request.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 216 def get_async(resource_group_name, service_name, sid, 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, 'sid is nil' if sid.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}/subscriptions/{sid}' 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,'sid' => sid,'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, ) 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::V2016_07_07::Models::SubscriptionContract.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 |
#get_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the specified Subscription entity.
will be added to the HTTP request.
201 202 203 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 201 def get_with_http_info(resource_group_name, service_name, sid, custom_headers:nil) get_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! end |
#list_by_service(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Array<SubscriptionContract>
Lists all subscriptions of the 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 | | stateComment | 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 | | state | eq | | will be added to the HTTP request.
51 52 53 54 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 51 def list_by_service(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil) first_page = list_by_service_as_lazy(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_service_as_lazy(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ SubscriptionCollection
Lists all subscriptions of the 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 | | stateComment | 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 | | state | eq | | will be added to the HTTP request.
response.
899 900 901 902 903 904 905 906 907 908 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 899 def list_by_service_as_lazy(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil) response = list_by_service_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_service_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_by_service_async(resource_group_name, service_name, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists all subscriptions of the 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 | | stateComment | 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 | | state | eq | | to the HTTP request.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 114 def list_by_service_async(resource_group_name, service_name, 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, "'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}/subscriptions' 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,'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::V2016_07_07::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., e.backtrace, result) end end result end promise.execute end |
#list_by_service_next(next_page_link, custom_headers: nil) ⇒ SubscriptionCollection
Lists all subscriptions of the API Management service instance.
to List operation. will be added to the HTTP request.
791 792 793 794 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 791 def list_by_service_next(next_page_link, custom_headers:nil) response = list_by_service_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists all subscriptions of the API Management service instance.
to List operation. to the HTTP request.
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 820 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 = { 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::V2016_07_07::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., e.backtrace, result) end end result end promise.execute end |
#list_by_service_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all subscriptions of the API Management service instance.
to List operation. will be added to the HTTP request.
806 807 808 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 806 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, filter: nil, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists all subscriptions of the 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 | | stateComment | 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 | | state | eq | | will be added to the HTTP request.
83 84 85 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 83 def list_by_service_with_http_info(resource_group_name, service_name, filter:nil, top:nil, skip:nil, custom_headers:nil) list_by_service_async(resource_group_name, service_name, filter:filter, top:top, skip:skip, custom_headers:custom_headers).value! end |
#regenerate_primary_key(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Object
Regenerates primary key of existing subscription of the API Management service instance.
will be added to the HTTP request.
606 607 608 609 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 606 def regenerate_primary_key(resource_group_name, service_name, sid, custom_headers:nil) response = regenerate_primary_key_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! nil end |
#regenerate_primary_key_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Regenerates primary key of existing subscription of the API Management service instance.
to the HTTP request.
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 639 def regenerate_primary_key_async(resource_group_name, service_name, sid, 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, 'sid is nil' if sid.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}/subscriptions/{sid}/regeneratePrimaryKey' 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,'sid' => sid,'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(:post, 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 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 |
#regenerate_primary_key_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Regenerates primary key of existing subscription of the API Management service instance.
will be added to the HTTP request.
623 624 625 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 623 def regenerate_primary_key_with_http_info(resource_group_name, service_name, sid, custom_headers:nil) regenerate_primary_key_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! end |
#regenerate_secondary_key(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Object
Regenerates secondary key of existing subscription of the API Management service instance.
will be added to the HTTP request.
699 700 701 702 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 699 def regenerate_secondary_key(resource_group_name, service_name, sid, custom_headers:nil) response = regenerate_secondary_key_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! nil end |
#regenerate_secondary_key_async(resource_group_name, service_name, sid, custom_headers: nil) ⇒ Concurrent::Promise
Regenerates secondary key of existing subscription of the API Management service instance.
to the HTTP request.
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 732 def regenerate_secondary_key_async(resource_group_name, service_name, sid, 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, 'sid is nil' if sid.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}/subscriptions/{sid}/regenerateSecondaryKey' 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,'sid' => sid,'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(:post, 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 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 |
#regenerate_secondary_key_with_http_info(resource_group_name, service_name, sid, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Regenerates secondary key of existing subscription of the API Management service instance.
will be added to the HTTP request.
716 717 718 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 716 def regenerate_secondary_key_with_http_info(resource_group_name, service_name, sid, custom_headers:nil) regenerate_secondary_key_async(resource_group_name, service_name, sid, custom_headers:custom_headers).value! end |
#update(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ Object
Updates the details of a subscription specified by its identifier.
the current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
396 397 398 399 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 396 def update(resource_group_name, service_name, sid, parameters, if_match, custom_headers:nil) response = update_async(resource_group_name, service_name, sid, parameters, if_match, custom_headers:custom_headers).value! nil end |
#update_async(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Updates the details of a subscription specified by its identifier.
the current entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 435 def update_async(resource_group_name, service_name, sid, parameters, if_match, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, 'sid is nil' if sid.nil? fail ArgumentError, 'parameters is nil' if parameters.nil? fail ArgumentError, 'if_match is nil' if if_match.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['If-Match'] = if_match unless if_match.nil? request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::ApiManagement::Mgmt::V2016_07_07::Models::SubscriptionUpdateParameters.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}' 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,'sid' => sid,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:patch, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 204 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? result end promise.execute end |
#update_with_http_info(resource_group_name, service_name, sid, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the details of a subscription specified by its identifier.
the current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
416 417 418 |
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/subscriptions.rb', line 416 def update_with_http_info(resource_group_name, service_name, sid, parameters, if_match, custom_headers:nil) update_async(resource_group_name, service_name, sid, parameters, if_match, custom_headers:custom_headers).value! end |