Class: Azure::ApiManagement::Mgmt::V2018_01_01::EmailTemplate
- Inherits:
-
Object
- Object
- Azure::ApiManagement::Mgmt::V2018_01_01::EmailTemplate
- Includes:
- MsRestAzure
- Defined in:
- lib/2018-01-01/generated/azure_mgmt_api_management/email_template.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, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ EmailTemplateContract
Updates an Email Template.
-
#create_or_update_async(resource_group_name, service_name, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise
Updates an Email Template.
-
#create_or_update_with_http_info(resource_group_name, service_name, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates an Email Template.
-
#delete(resource_group_name, service_name, template_name, if_match, custom_headers: nil) ⇒ Object
Reset the Email Template to default template provided by the API Management service instance.
-
#delete_async(resource_group_name, service_name, template_name, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Reset the Email Template to default template provided by the API Management service instance.
-
#delete_with_http_info(resource_group_name, service_name, template_name, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Reset the Email Template to default template provided by the API Management service instance.
-
#get(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ EmailTemplateContract
Gets the details of the email template specified by its identifier.
-
#get_async(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the email template specified by its identifier.
-
#get_entity_tag(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Object
Gets the entity state (Etag) version of the email template specified by its identifier.
-
#get_entity_tag_async(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets the entity state (Etag) version of the email template specified by its identifier.
-
#get_entity_tag_with_http_info(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the entity state (Etag) version of the email template specified by its identifier.
-
#get_with_http_info(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the email template specified by its identifier.
-
#initialize(client) ⇒ EmailTemplate
constructor
Creates and initializes a new instance of the EmailTemplate class.
-
#list_by_service(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ Array<EmailTemplateContract>
Lists a collection of properties defined within a service instance.
-
#list_by_service_as_lazy(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ EmailTemplateCollection
Lists a collection of properties defined within a service instance.
-
#list_by_service_async(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of properties defined within a service instance.
-
#list_by_service_next(next_page_link, custom_headers: nil) ⇒ EmailTemplateCollection
Lists a collection of properties defined within a service instance.
-
#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of properties defined within a service instance.
-
#list_by_service_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of properties defined within a service instance.
-
#list_by_service_with_http_info(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of properties defined within a service instance.
-
#update(resource_group_name, service_name, template_name, parameters, custom_headers: nil) ⇒ Object
Updates the specific Email Template.
-
#update_async(resource_group_name, service_name, template_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Updates the specific Email Template.
-
#update_with_http_info(resource_group_name, service_name, template_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the specific Email Template.
Constructor Details
#initialize(client) ⇒ EmailTemplate
Creates and initializes a new instance of the EmailTemplate class.
17 18 19 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.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/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 22 def client @client end |
Instance Method Details
#create_or_update(resource_group_name, service_name, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ EmailTemplateContract
Updates an Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ parameters. entity, but required when updating an entity. will be added to the HTTP request.
401 402 403 404 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 401 def create_or_update(resource_group_name, service_name, template_name, parameters, if_match:nil, custom_headers:nil) response = create_or_update_async(resource_group_name, service_name, template_name, parameters, if_match:if_match, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(resource_group_name, service_name, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise
Updates an Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ parameters. entity, but required when updating an entity. to the HTTP request.
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 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 533 534 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 458 def create_or_update_async(resource_group_name, service_name, template_name, parameters, if_match:nil, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, 'template_name is nil' if template_name.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['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::V2018_01_01::Models::EmailTemplateUpdateParameters.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}/templates/{templateName}' 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,'templateName' => template_name,'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 == 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::EmailTemplateContract.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::EmailTemplateContract.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, template_name, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates an Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ parameters. entity, but required when updating an entity. will be added to the HTTP request.
430 431 432 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 430 def create_or_update_with_http_info(resource_group_name, service_name, template_name, parameters, if_match:nil, custom_headers:nil) create_or_update_async(resource_group_name, service_name, template_name, parameters, if_match:if_match, custom_headers:custom_headers).value! end |
#delete(resource_group_name, service_name, template_name, if_match, custom_headers: nil) ⇒ Object
Reset the Email Template to default template provided by the API Management service instance.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
687 688 689 690 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 687 def delete(resource_group_name, service_name, template_name, if_match, custom_headers:nil) response = delete_async(resource_group_name, service_name, template_name, if_match, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, service_name, template_name, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Reset the Email Template to default template provided by the API Management service instance.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.
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 780 781 782 783 784 785 786 787 788 789 790 791 792 793 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 744 def delete_async(resource_group_name, service_name, template_name, 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, 'template_name is nil' if template_name.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}/templates/{templateName}' 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,'templateName' => template_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(: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, template_name, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Reset the Email Template to default template provided by the API Management service instance.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
716 717 718 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 716 def delete_with_http_info(resource_group_name, service_name, template_name, if_match, custom_headers:nil) delete_async(resource_group_name, service_name, template_name, if_match, custom_headers:custom_headers).value! end |
#get(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ EmailTemplateContract
Gets the details of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
269 270 271 272 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 269 def get(resource_group_name, service_name, template_name, custom_headers:nil) response = get_async(resource_group_name, service_name, template_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ to the HTTP request.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 318 def get_async(resource_group_name, service_name, template_name, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, 'template_name is nil' if template_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}' 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,'templateName' => template_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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::EmailTemplateContract.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_entity_tag(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Object
Gets the entity state (Etag) version of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
149 150 151 152 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 149 def get_entity_tag(resource_group_name, service_name, template_name, custom_headers:nil) response = get_entity_tag_async(resource_group_name, service_name, template_name, custom_headers:custom_headers).value! nil end |
#get_entity_tag_async(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets the entity state (Etag) version of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ to the HTTP request.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 200 def get_entity_tag_async(resource_group_name, service_name, template_name, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, 'template_name is nil' if template_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}' 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,'templateName' => template_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(: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 == 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? result end promise.execute end |
#get_entity_tag_with_http_info(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the entity state (Etag) version of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
175 176 177 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 175 def get_entity_tag_with_http_info(resource_group_name, service_name, template_name, custom_headers:nil) get_entity_tag_async(resource_group_name, service_name, template_name, custom_headers:custom_headers).value! end |
#get_with_http_info(resource_group_name, service_name, template_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the email template specified by its identifier.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
294 295 296 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 294 def get_with_http_info(resource_group_name, service_name, template_name, custom_headers:nil) get_async(resource_group_name, service_name, template_name, custom_headers:custom_headers).value! end |
#list_by_service(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ Array<EmailTemplateContract>
Lists a collection of properties defined within a service instance.
will be added to the HTTP request.
36 37 38 39 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 36 def list_by_service(resource_group_name, service_name, top:nil, skip:nil, custom_headers:nil) first_page = list_by_service_as_lazy(resource_group_name, service_name, top:top, skip:skip, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_service_as_lazy(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ EmailTemplateCollection
Lists a collection of properties defined within a service instance.
will be added to the HTTP request.
response.
898 899 900 901 902 903 904 905 906 907 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 898 def list_by_service_as_lazy(resource_group_name, service_name, top:nil, skip:nil, custom_headers:nil) response = list_by_service_async(resource_group_name, service_name, top:top, skip:skip, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_service_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_by_service_async(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of properties defined within a service instance.
to the HTTP request.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 69 def list_by_service_async(resource_group_name, service_name, top:nil, skip:nil, custom_headers:nil) fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'service_name is nil' if service_name.nil? fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50 fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1 fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil? fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0 fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates' 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: {'$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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::EmailTemplateCollection.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) ⇒ EmailTemplateCollection
Lists a collection of properties defined within a service instance.
to List operation. will be added to the HTTP request.
805 806 807 808 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 805 def list_by_service_next(next_page_link, custom_headers:nil) response = list_by_service_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_service_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists a collection of properties defined within a service instance.
to List operation. to the HTTP request.
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 870 871 872 873 874 875 876 877 878 879 880 881 882 883 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 834 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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2018_01_01::Models::EmailTemplateCollection.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 a collection of properties defined within a service instance.
to List operation. will be added to the HTTP request.
820 821 822 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 820 def list_by_service_next_with_http_info(next_page_link, custom_headers:nil) list_by_service_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_by_service_with_http_info(resource_group_name, service_name, top: nil, skip: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists a collection of properties defined within a service instance.
will be added to the HTTP request.
53 54 55 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 53 def list_by_service_with_http_info(resource_group_name, service_name, top:nil, skip:nil, custom_headers:nil) list_by_service_async(resource_group_name, service_name, top:top, skip:skip, custom_headers:custom_headers).value! end |
#update(resource_group_name, service_name, template_name, parameters, custom_headers: nil) ⇒ Object
Updates the specific Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
556 557 558 559 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 556 def update(resource_group_name, service_name, template_name, parameters, custom_headers:nil) response = update_async(resource_group_name, service_name, template_name, parameters, custom_headers:custom_headers).value! nil end |
#update_async(resource_group_name, service_name, template_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Updates the specific Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ to the HTTP request.
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 607 def update_async(resource_group_name, service_name, template_name, 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, 'template_name is nil' if template_name.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::V2018_01_01::Models::EmailTemplateUpdateParameters.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}/templates/{templateName}' 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,'templateName' => template_name,'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, template_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Updates the specific Email Template.
values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’ will be added to the HTTP request.
582 583 584 |
# File 'lib/2018-01-01/generated/azure_mgmt_api_management/email_template.rb', line 582 def update_with_http_info(resource_group_name, service_name, template_name, parameters, custom_headers:nil) update_async(resource_group_name, service_name, template_name, parameters, custom_headers:custom_headers).value! end |