Class: Azure::ApiManagement::Mgmt::V2016_10_10::Property
- Inherits:
-
Object
- Object
- Azure::ApiManagement::Mgmt::V2016_10_10::Property
- Includes:
- MsRestAzure
- Defined in:
- lib/2016-10-10/generated/azure_mgmt_api_management/property.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, prop_id, parameters, custom_headers: nil) ⇒ Object
Creates or updates a property.
-
#create_or_update_async(resource_group_name, service_name, prop_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates a property.
-
#create_or_update_with_http_info(resource_group_name, service_name, prop_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a property.
-
#delete(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ ErrorBodyContract
Deletes specific property from the API Management service instance.
-
#delete_async(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes specific property from the API Management service instance.
-
#delete_with_http_info(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes specific property from the API Management service instance.
-
#get(resource_group_name, service_name, prop_id, custom_headers: nil) ⇒ PropertyContract
Gets the details of the property specified by its identifier.
-
#get_async(resource_group_name, service_name, prop_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the property specified by its identifier.
-
#get_with_http_info(resource_group_name, service_name, prop_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the property specified by its identifier.
-
#initialize(client) ⇒ Property
constructor
Creates and initializes a new instance of the Property class.
-
#update(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers: nil) ⇒ Object
Updates the specific property.
-
#update_async(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Updates the specific property.
-
#update_with_http_info(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the specific property.
Constructor Details
#initialize(client) ⇒ Property
Creates and initializes a new instance of the Property class.
17 18 19 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.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-10-10/generated/azure_mgmt_api_management/property.rb', line 22 def client @client end |
Instance Method Details
#create_or_update(resource_group_name, service_name, prop_id, parameters, custom_headers: nil) ⇒ Object
Creates or updates a property.
will be added to the HTTP request.
138 139 140 141 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 138 def create_or_update(resource_group_name, service_name, prop_id, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, service_name, prop_id, parameters, custom_headers:custom_headers).value! nil end |
#create_or_update_async(resource_group_name, service_name, prop_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates a property.
to the HTTP request.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 171 def create_or_update_async(resource_group_name, service_name, prop_id, 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, 'prop_id is nil' if prop_id.nil? fail ArgumentError, "'prop_id' should satisfy the constraint - 'MaxLength': '256'" if !prop_id.nil? && prop_id.length > 256 fail ArgumentError, "'prop_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !prop_id.nil? && prop_id.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_10_10::Models::PropertyCreateParameters.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}/properties/{propId}' 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,'propId' => prop_id,'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, prop_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a property.
will be added to the HTTP request.
155 156 157 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 155 def create_or_update_with_http_info(resource_group_name, service_name, prop_id, parameters, custom_headers:nil) create_or_update_async(resource_group_name, service_name, prop_id, parameters, custom_headers:custom_headers).value! end |
#delete(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ ErrorBodyContract
Deletes specific property from the API Management service instance.
delete. A value of “*” can be used for If-Match to unconditionally apply the operation. will be added to the HTTP request.
358 359 360 361 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 358 def delete(resource_group_name, service_name, prop_id, if_match, custom_headers:nil) response = delete_async(resource_group_name, service_name, prop_id, if_match, custom_headers:custom_headers).value! response.body unless response.nil? end |
#delete_async(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes specific property from the API Management service instance.
delete. A value of “*” can be used for If-Match to unconditionally apply the operation. to the HTTP request.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 395 def delete_async(resource_group_name, service_name, prop_id, 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, 'prop_id is nil' if prop_id.nil? fail ArgumentError, "'prop_id' should satisfy the constraint - 'MaxLength': '256'" if !prop_id.nil? && prop_id.length > 256 fail ArgumentError, "'prop_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !prop_id.nil? && prop_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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}/properties/{propId}' 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,'propId' => prop_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 == 204 || status_code == 405 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 == 405 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2016_10_10::Models::ErrorBodyContract.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 |
#delete_with_http_info(resource_group_name, service_name, prop_id, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes specific property from the API Management service instance.
delete. A value of “*” can be used for If-Match to unconditionally apply the operation. will be added to the HTTP request.
377 378 379 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 377 def delete_with_http_info(resource_group_name, service_name, prop_id, if_match, custom_headers:nil) delete_async(resource_group_name, service_name, prop_id, if_match, custom_headers:custom_headers).value! end |
#get(resource_group_name, service_name, prop_id, custom_headers: nil) ⇒ PropertyContract
Gets the details of the property specified by its identifier.
will be added to the HTTP request.
35 36 37 38 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 35 def get(resource_group_name, service_name, prop_id, custom_headers:nil) response = get_async(resource_group_name, service_name, prop_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, service_name, prop_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the property specified by its identifier.
to the HTTP request.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 66 def get_async(resource_group_name, service_name, prop_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, 'prop_id is nil' if prop_id.nil? fail ArgumentError, "'prop_id' should satisfy the constraint - 'MaxLength': '256'" if !prop_id.nil? && prop_id.length > 256 fail ArgumentError, "'prop_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !prop_id.nil? && prop_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}/properties/{propId}' 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,'propId' => prop_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(: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_10_10::Models::PropertyContract.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, prop_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the property specified by its identifier.
will be added to the HTTP request.
51 52 53 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 51 def get_with_http_info(resource_group_name, service_name, prop_id, custom_headers:nil) get_async(resource_group_name, service_name, prop_id, custom_headers:custom_headers).value! end |
#update(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers: nil) ⇒ Object
Updates the specific property.
update. A value of “*” can be used for If-Match to unconditionally apply the operation. will be added to the HTTP request.
244 245 246 247 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 244 def update(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers:nil) response = update_async(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers:custom_headers).value! nil end |
#update_async(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Updates the specific property.
update. A value of “*” can be used for If-Match to unconditionally apply the operation. to the HTTP request.
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 283 def update_async(resource_group_name, service_name, prop_id, 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, 'prop_id is nil' if prop_id.nil? fail ArgumentError, "'prop_id' should satisfy the constraint - 'MaxLength': '256'" if !prop_id.nil? && prop_id.length > 256 fail ArgumentError, "'prop_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !prop_id.nil? && prop_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).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_10_10::Models::PropertyUpdateParameters.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}/properties/{propId}' 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,'propId' => prop_id,'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, prop_id, parameters, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the specific property.
update. A value of “*” can be used for If-Match to unconditionally apply the operation. will be added to the HTTP request.
264 265 266 |
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/property.rb', line 264 def update_with_http_info(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers:nil) update_async(resource_group_name, service_name, prop_id, parameters, if_match, custom_headers:custom_headers).value! end |