Class: Azure::IotHub::Mgmt::V2018_01_22::Certificates

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb

Overview

Use this API to manage the IoT hubs in your Azure subscription.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Certificates

Creates and initializes a new instance of the Certificates class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ IotHubClient (readonly)

Returns reference to the IotHubClient.

Returns:



22
23
24
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, resource_name, certificate_name, certificate_description, if_match: nil, custom_headers: nil) ⇒ CertificateDescription

Upload the certificate to the IoT hub.

Adds new or replaces existing certificate.

contains the IoT hub. body. a brand new certificate. Required to update an existing certificate. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_description (CertificateBodyDescription) —

    The certificate

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

    ETag of the Certificate. Do not specify for creating

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

    A hash of custom headers that

Returns:

  • (CertificateDescription) —

    operation results.



253
254
255
256
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 253

def create_or_update(resource_group_name, resource_name, certificate_name, certificate_description, if_match:nil, custom_headers:nil)
  response = create_or_update_async(resource_group_name, resource_name, certificate_name, certificate_description, if_match:if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, resource_name, certificate_name, certificate_description, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Upload the certificate to the IoT hub.

Adds new or replaces existing certificate.

contains the IoT hub. body. a brand new certificate. Required to update an existing certificate. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_description (CertificateBodyDescription) —

    The certificate

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

    ETag of the Certificate. Do not specify for creating

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 298

def create_or_update_async(resource_group_name, resource_name, certificate_name, certificate_description, if_match:nil, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9-._]{1,64}$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[A-Za-z0-9-._]{1,64}$$')).nil?
  fail ArgumentError, 'certificate_description is nil' if certificate_description.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::IotHub::Mgmt::V2018_01_22::Models::CertificateBodyDescription.mapper()
  request_content = @client.serialize(request_mapper,  certificate_description)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'certificateName' => certificate_name},
      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, options)

  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::IotHub::Mgmt::V2018_01_22::Models::CertificateDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::IotHub::Mgmt::V2018_01_22::Models::CertificateDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_or_update_with_http_info(resource_group_name, resource_name, certificate_name, certificate_description, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Upload the certificate to the IoT hub.

Adds new or replaces existing certificate.

contains the IoT hub. body. a brand new certificate. Required to update an existing certificate. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_description (CertificateBodyDescription) —

    The certificate

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

    ETag of the Certificate. Do not specify for creating

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



276
277
278
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 276

def create_or_update_with_http_info(resource_group_name, resource_name, certificate_name, certificate_description, if_match:nil, custom_headers:nil)
  create_or_update_async(resource_group_name, resource_name, certificate_name, certificate_description, if_match:if_match, custom_headers:custom_headers).value!
end

#delete(resource_group_name, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ Object

Delete an X509 certificate.

Deletes an existing X509 certificate or does nothing if it does not exist.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that



388
389
390
391
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 388

def delete(resource_group_name, resource_name, certificate_name, if_match, custom_headers:nil)
  response = delete_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ Concurrent::Promise

Delete an X509 certificate.

Deletes an existing X509 certificate or does nothing if it does not exist.

contains the IoT hub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 427

def delete_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9-._]{1,64}$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[A-Za-z0-9-._]{1,64}$$')).nil?
  fail ArgumentError, 'if_match is nil' if if_match.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.Devices/IotHubs/{resourceName}/certificates/{certificateName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'certificateName' => certificate_name},
      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, options)

  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, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete an X509 certificate.

Deletes an existing X509 certificate or does nothing if it does not exist.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



408
409
410
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 408

def delete_with_http_info(resource_group_name, resource_name, certificate_name, if_match, custom_headers:nil)
  delete_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers:custom_headers).value!
end

#generate_verification_code(resource_group_name, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ CertificateWithNonceDescription

Generate verification code for proof of possession flow.

Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that

Returns:

  • (CertificateWithNonceDescription) —

    operation results.



492
493
494
495
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 492

def generate_verification_code(resource_group_name, resource_name, certificate_name, if_match, custom_headers:nil)
  response = generate_verification_code_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#generate_verification_code_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ Concurrent::Promise

Generate verification code for proof of possession flow.

Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.

contains the IoT hub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



533
534
535
536
537
538
539
540
541
542
543
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
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 533

def generate_verification_code_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9-._]{1,64}$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[A-Za-z0-9-._]{1,64}$$')).nil?
  fail ArgumentError, 'if_match is nil' if if_match.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.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'certificateName' => certificate_name},
      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, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::IotHub::Mgmt::V2018_01_22::Models::CertificateWithNonceDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#generate_verification_code_with_http_info(resource_group_name, resource_name, certificate_name, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Generate verification code for proof of possession flow.

Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



513
514
515
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 513

def generate_verification_code_with_http_info(resource_group_name, resource_name, certificate_name, if_match, custom_headers:nil)
  generate_verification_code_async(resource_group_name, resource_name, certificate_name, if_match, custom_headers:custom_headers).value!
end

#get(resource_group_name, resource_name, certificate_name, custom_headers: nil) ⇒ CertificateDescription

Get the certificate.

Returns the certificate.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

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

    A hash of custom headers that

Returns:

  • (CertificateDescription) —

    operation results.



141
142
143
144
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 141

def get(resource_group_name, resource_name, certificate_name, custom_headers:nil)
  response = get_async(resource_group_name, resource_name, certificate_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, resource_name, certificate_name, custom_headers: nil) ⇒ Concurrent::Promise

Get the certificate.

Returns the certificate.

contains the IoT hub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
229
230
231
232
233
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 178

def get_async(resource_group_name, resource_name, certificate_name, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9-._]{1,64}$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[A-Za-z0-9-._]{1,64}$$')).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.Devices/IotHubs/{resourceName}/certificates/{certificateName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'certificateName' => certificate_name},
      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, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::IotHub::Mgmt::V2018_01_22::Models::CertificateDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, resource_name, certificate_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the certificate.

Returns the certificate.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



160
161
162
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 160

def get_with_http_info(resource_group_name, resource_name, certificate_name, custom_headers:nil)
  get_async(resource_group_name, resource_name, certificate_name, custom_headers:custom_headers).value!
end

#list_by_iot_hub(resource_group_name, resource_name, custom_headers: nil) ⇒ CertificateListDescription

Get the certificate list.

Returns the list of certificates.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

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

    A hash of custom headers that

Returns:

  • (CertificateListDescription) —

    operation results.



37
38
39
40
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 37

def list_by_iot_hub(resource_group_name, resource_name, custom_headers:nil)
  response = list_by_iot_hub_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_iot_hub_async(resource_group_name, resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Get the certificate list.

Returns the list of certificates.

contains the IoT hub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 72

def list_by_iot_hub_async(resource_group_name, resource_name, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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.Devices/IotHubs/{resourceName}/certificates'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::IotHub::Mgmt::V2018_01_22::Models::CertificateListDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_iot_hub_with_http_info(resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the certificate list.

Returns the list of certificates.

contains the IoT hub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 55

def list_by_iot_hub_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  list_by_iot_hub_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end

#verify(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers: nil) ⇒ CertificateDescription

Verify certificate’s private key possession.

Verifies the certificate’s private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

contains the IoT hub. name of the certificate will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_verification_body (CertificateVerificationDescription) —

    The

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that

Returns:

  • (CertificateDescription) —

    operation results.



610
611
612
613
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 610

def verify(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers:nil)
  response = verify_async(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#verify_async(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers: nil) ⇒ Concurrent::Promise

Verify certificate’s private key possession.

Verifies the certificate’s private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

contains the IoT hub. name of the certificate to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_verification_body (CertificateVerificationDescription) —

    The

  • if_match (String) —

    ETag of the Certificate.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 655

def verify_async(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers: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?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'certificate_name is nil' if certificate_name.nil?
  fail ArgumentError, "'certificate_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9-._]{1,64}$'" if !certificate_name.nil? && certificate_name.match(Regexp.new('^^[A-Za-z0-9-._]{1,64}$$')).nil?
  fail ArgumentError, 'certificate_verification_body is nil' if certificate_verification_body.nil?
  fail ArgumentError, 'if_match is nil' if if_match.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::IotHub::Mgmt::V2018_01_22::Models::CertificateVerificationDescription.mapper()
  request_content = @client.serialize(request_mapper,  certificate_verification_body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name,'certificateName' => certificate_name},
      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(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::IotHub::Mgmt::V2018_01_22::Models::CertificateDescription.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#verify_with_http_info(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Verify certificate’s private key possession.

Verifies the certificate’s private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.

contains the IoT hub. name of the certificate will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the IoT hub.

  • certificate_name (String) —

    The name of the certificate

  • certificate_verification_body (CertificateVerificationDescription) —

    The

  • if_match (String) —

    ETag of the Certificate.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



633
634
635
 
# File 'lib/2018-01-22/generated/azure_mgmt_iot_hub/certificates.rb', line 633

def verify_with_http_info(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers:nil)
  verify_async(resource_group_name, resource_name, certificate_name, certificate_verification_body, if_match, custom_headers:custom_headers).value!
end