Class: Azure::ApiManagement::Mgmt::V2019_12_01::TenantAccess

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TenantAccess

Creates and initializes a new instance of the TenantAccess class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ApiManagementClient (readonly)

Returns reference to the ApiManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, service_name, custom_headers: nil) ⇒ AccessInformationContract

Get tenant access information details without secrets.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (AccessInformationContract) —

    operation results.



121
122
123
124
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 121

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

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

Get tenant access information details without secrets.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 150

def get_async(resource_group_name, service_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  access_name = 'access'


  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}/tenant/{accessName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'subscriptionId' => @client.subscription_id,'accessName' => access_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::ApiManagement::Mgmt::V2019_12_01::Models::AccessInformationContract.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_entity_tag(resource_group_name, service_name, custom_headers: nil) ⇒ Object

Tenant access metadata

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that



33
34
35
36
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 33

def get_entity_tag(resource_group_name, service_name, custom_headers:nil)
  response = get_entity_tag_async(resource_group_name, service_name, custom_headers:custom_headers).value!
  nil
end

#get_entity_tag_async(resource_group_name, service_name, custom_headers: nil) ⇒ Concurrent::Promise

Tenant access metadata

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



62
63
64
65
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
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 62

def get_entity_tag_async(resource_group_name, service_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  access_name = 'access'


  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}/tenant/{accessName}'

  request_url = @base_url || @client.base_url

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

    result
  end

  promise.execute
end

#get_entity_tag_with_http_info(resource_group_name, service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Tenant access metadata

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



48
49
50
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 48

def get_entity_tag_with_http_info(resource_group_name, service_name, custom_headers:nil)
  get_entity_tag_async(resource_group_name, service_name, custom_headers:custom_headers).value!
end

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

Get tenant access information details without secrets.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



136
137
138
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 136

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

#list_secrets(resource_group_name, service_name, custom_headers: nil) ⇒ AccessInformationContract

Get tenant access information details.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (AccessInformationContract) —

    operation results.



505
506
507
508
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 505

def list_secrets(resource_group_name, service_name, custom_headers:nil)
  response = list_secrets_async(resource_group_name, service_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_secrets_async(resource_group_name, service_name, custom_headers: nil) ⇒ Concurrent::Promise

Get tenant access information details.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
591
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 534

def list_secrets_async(resource_group_name, service_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  access_name = 'access'


  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}/tenant/{accessName}/listSecrets'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'subscriptionId' => @client.subscription_id,'accessName' => access_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::ApiManagement::Mgmt::V2019_12_01::Models::AccessInformationContract.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_secrets_with_http_info(resource_group_name, service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get tenant access information details.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



520
521
522
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 520

def list_secrets_with_http_info(resource_group_name, service_name, custom_headers:nil)
  list_secrets_async(resource_group_name, service_name, custom_headers:custom_headers).value!
end

#regenerate_primary_key(resource_group_name, service_name, custom_headers: nil) ⇒ Object

Regenerate primary access key

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that



330
331
332
333
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 330

def regenerate_primary_key(resource_group_name, service_name, custom_headers:nil)
  response = regenerate_primary_key_async(resource_group_name, service_name, custom_headers:custom_headers).value!
  nil
end

#regenerate_primary_key_async(resource_group_name, service_name, custom_headers: nil) ⇒ Concurrent::Promise

Regenerate primary access key

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 359

def regenerate_primary_key_async(resource_group_name, service_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  access_name = 'access'


  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}/tenant/{accessName}/regeneratePrimaryKey'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'subscriptionId' => @client.subscription_id,'accessName' => access_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 == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#regenerate_primary_key_with_http_info(resource_group_name, service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerate primary access key

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



345
346
347
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 345

def regenerate_primary_key_with_http_info(resource_group_name, service_name, custom_headers:nil)
  regenerate_primary_key_async(resource_group_name, service_name, custom_headers:custom_headers).value!
end

#regenerate_secondary_key(resource_group_name, service_name, custom_headers: nil) ⇒ Object

Regenerate secondary access key

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that



417
418
419
420
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 417

def regenerate_secondary_key(resource_group_name, service_name, custom_headers:nil)
  response = regenerate_secondary_key_async(resource_group_name, service_name, custom_headers:custom_headers).value!
  nil
end

#regenerate_secondary_key_async(resource_group_name, service_name, custom_headers: nil) ⇒ Concurrent::Promise

Regenerate secondary access key

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 446

def regenerate_secondary_key_async(resource_group_name, service_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  access_name = 'access'


  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}/tenant/{accessName}/regenerateSecondaryKey'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'subscriptionId' => @client.subscription_id,'accessName' => access_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 == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#regenerate_secondary_key_with_http_info(resource_group_name, service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerate secondary access key

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



432
433
434
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 432

def regenerate_secondary_key_with_http_info(resource_group_name, service_name, custom_headers:nil)
  regenerate_secondary_key_async(resource_group_name, service_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, service_name, parameters, if_match, custom_headers: nil) ⇒ Object

Update tenant access information details.

retrieve the Tenant Access Information. entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • parameters (AccessInformationUpdateParameters) —

    Parameters supplied to

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that



223
224
225
226
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 223

def update(resource_group_name, service_name, parameters, if_match, custom_headers:nil)
  response = update_async(resource_group_name, service_name, parameters, if_match, custom_headers:custom_headers).value!
  nil
end

#update_async(resource_group_name, service_name, parameters, if_match, custom_headers: nil) ⇒ Concurrent::Promise

Update tenant access information details.

retrieve the Tenant Access Information. entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • parameters (AccessInformationUpdateParameters) —

    Parameters supplied to

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 262

def update_async(resource_group_name, service_name, 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, 'parameters is nil' if parameters.nil?
  access_name = 'access'
  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::V2019_12_01::Models::AccessInformationUpdateParameters.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}/tenant/{accessName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'accessName' => access_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, options)

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

Update tenant access information details.

retrieve the Tenant Access Information. entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • parameters (AccessInformationUpdateParameters) —

    Parameters supplied to

  • if_match (String) —

    ETag of the Entity. ETag should match the current

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



243
244
245
 
# File 'lib/2019-12-01/generated/azure_mgmt_api_management/tenant_access.rb', line 243

def update_with_http_info(resource_group_name, service_name, parameters, if_match, custom_headers:nil)
  update_async(resource_group_name, service_name, parameters, if_match, custom_headers:custom_headers).value!
end