Class: Azure::ARM::Graph::Users

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_graph/users.rb

Overview

Composite Swagger for GraphRbac Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Users

Creates and initializes a new instance of the Users class.

Parameters:

  • client

    service class for accessing basic functionality.



18
19
20
# File 'lib/generated/azure_mgmt_graph/users.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientGraphRbacManagementClient (readonly)

Returns reference to the GraphRbacManagementClient.

Returns:



23
24
25
# File 'lib/generated/azure_mgmt_graph/users.rb', line 23

def client
  @client
end

Instance Method Details

#create(parameters, custom_headers = nil) ⇒ User

Create a new user. Reference: msdn.microsoft.com/library/azure/ad/graph/api/users-operations#CreateUser

will be added to the HTTP request.

Parameters:

  • parameters (UserCreateParameters)

    Parameters to create a user.

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

    A hash of custom headers that

Returns:

  • (User)

    operation results.



35
36
37
38
# File 'lib/generated/azure_mgmt_graph/users.rb', line 35

def create(parameters, custom_headers = nil)
  response = create_async(parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_async(parameters, custom_headers = nil) ⇒ Concurrent::Promise

Create a new user. Reference: msdn.microsoft.com/library/azure/ad/graph/api/users-operations#CreateUser

to the HTTP request.

Parameters:

  • parameters (UserCreateParameters)

    Parameters to create a user.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/generated/azure_mgmt_graph/users.rb', line 64

def create_async(parameters, custom_headers = nil)
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = UserCreateParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/{tenantID}/users'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      query_params: {'api-version' => 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 == 201
      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?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = User.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_with_http_info(parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Create a new user. Reference: msdn.microsoft.com/library/azure/ad/graph/api/users-operations#CreateUser

will be added to the HTTP request.

Parameters:

  • parameters (UserCreateParameters)

    Parameters to create a user.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



50
51
52
# File 'lib/generated/azure_mgmt_graph/users.rb', line 50

def create_with_http_info(parameters, custom_headers = nil)
  create_async(parameters, custom_headers).value!
end

#delete(upn_or_object_id, custom_headers = nil) ⇒ Object

Delete a user. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#DeleteUser

will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    user object id or user principal name (upn)

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

    A hash of custom headers that



436
437
438
439
# File 'lib/generated/azure_mgmt_graph/users.rb', line 436

def delete(upn_or_object_id, custom_headers = nil)
  response = delete_async(upn_or_object_id, custom_headers).value!
  nil
end

#delete_async(upn_or_object_id, custom_headers = nil) ⇒ Concurrent::Promise

Parameters:

  • upn_or_object_id (String)

    user object id or user principal name (upn)

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/generated/azure_mgmt_graph/users.rb', line 465

def delete_async(upn_or_object_id, custom_headers = nil)
  fail ArgumentError, 'upn_or_object_id is nil' if upn_or_object_id.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # 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 = '/{tenantID}/users/{upnOrObjectId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      skip_encoding_path_params: {'upnOrObjectId' => upn_or_object_id},
      query_params: {'api-version' => 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 == 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
  end

  promise.execute
end

#delete_with_http_info(upn_or_object_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a user. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#DeleteUser

will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    user object id or user principal name (upn)

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



451
452
453
# File 'lib/generated/azure_mgmt_graph/users.rb', line 451

def delete_with_http_info(upn_or_object_id, custom_headers = nil)
  delete_async(upn_or_object_id, custom_headers).value!
end

#get(upn_or_object_id, custom_headers = nil) ⇒ User

Gets user information from the directory. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetAUser

get user information. will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

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

    A hash of custom headers that

Returns:

  • (User)

    operation results.



245
246
247
248
# File 'lib/generated/azure_mgmt_graph/users.rb', line 245

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

#get_async(upn_or_object_id, custom_headers = nil) ⇒ Concurrent::Promise

Gets user information from the directory. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetAUser

get user information. to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
320
321
322
323
324
325
326
# File 'lib/generated/azure_mgmt_graph/users.rb', line 276

def get_async(upn_or_object_id, custom_headers = nil)
  fail ArgumentError, 'upn_or_object_id is nil' if upn_or_object_id.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # 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 = '/{tenantID}/users/{upnOrObjectId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      skip_encoding_path_params: {'upnOrObjectId' => upn_or_object_id},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = User.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_member_groups(object_id, parameters, custom_headers = nil) ⇒ UserGetMemberGroupsResult

Gets a collection that contains the Object IDs of the groups of which the user is a member.

will be added to the HTTP request.

Parameters:

  • object_id (String)

    User filtering parameters.

  • parameters (UserGetMemberGroupsParameters)

    User filtering parameters.

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

    A hash of custom headers that

Returns:



518
519
520
521
# File 'lib/generated/azure_mgmt_graph/users.rb', line 518

def get_member_groups(object_id, parameters, custom_headers = nil)
  response = get_member_groups_async(object_id, parameters, custom_headers).value!
  response.body unless response.nil?
end

#get_member_groups_async(object_id, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Gets a collection that contains the Object IDs of the groups of which the user is a member.

to the HTTP request.

Parameters:

  • object_id (String)

    User filtering parameters.

  • parameters (UserGetMemberGroupsParameters)

    User filtering parameters.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
# File 'lib/generated/azure_mgmt_graph/users.rb', line 549

def get_member_groups_async(object_id, parameters, custom_headers = nil)
  fail ArgumentError, 'object_id is nil' if object_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = UserGetMemberGroupsParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/{tenantID}/users/{objectId}/getMemberGroups'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      skip_encoding_path_params: {'objectId' => object_id},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = UserGetMemberGroupsResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_member_groups_with_http_info(object_id, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a collection that contains the Object IDs of the groups of which the user is a member.

will be added to the HTTP request.

Parameters:

  • object_id (String)

    User filtering parameters.

  • parameters (UserGetMemberGroupsParameters)

    User filtering parameters.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



534
535
536
# File 'lib/generated/azure_mgmt_graph/users.rb', line 534

def get_member_groups_with_http_info(object_id, parameters, custom_headers = nil)
  get_member_groups_async(object_id, parameters, custom_headers).value!
end

#get_with_http_info(upn_or_object_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets user information from the directory. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetAUser

get user information. will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



261
262
263
# File 'lib/generated/azure_mgmt_graph/users.rb', line 261

def get_with_http_info(upn_or_object_id, custom_headers = nil)
  get_async(upn_or_object_id, custom_headers).value!
end

#list(filter = nil, custom_headers = nil) ⇒ Array<User>

Gets list of users for the current tenant. Reference msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetUsers

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (Array<User>)

    operation results.



155
156
157
158
# File 'lib/generated/azure_mgmt_graph/users.rb', line 155

def list(filter = nil, custom_headers = nil)
  first_page = list_as_lazy(filter, custom_headers)
  first_page.get_all_items
end

#list_as_lazy(filter = nil, custom_headers = nil) ⇒ UserListResult

Gets list of users for the current tenant. Reference msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetUsers

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (UserListResult)

    which provide lazy access to pages of the response.



134
135
136
137
138
139
140
141
142
143
# File 'lib/generated/azure_mgmt_graph/users.rb', line 134

def list_as_lazy(filter = nil, custom_headers = nil)
  response = list_async(filter, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_async(filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets list of users for the current tenant. Reference msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetUsers

to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/generated/azure_mgmt_graph/users.rb', line 184

def list_async(filter = nil, custom_headers = nil)
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # 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 = '/{tenantID}/users'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      query_params: {'$filter' => filter,'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = UserListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_next(next_link, custom_headers = nil) ⇒ Array<User>

Gets list of users for the current tenant.

will be added to the HTTP request.

Parameters:

  • next_link (String)

    Next link for list operation.

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

    A hash of custom headers that

Returns:

  • (Array<User>)

    operation results.



620
621
622
623
# File 'lib/generated/azure_mgmt_graph/users.rb', line 620

def list_next(next_link, custom_headers = nil)
  response = list_next_async(next_link, custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets list of users for the current tenant.

to the HTTP request.

Parameters:

  • next_link (String)

    Next link for list operation.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
# File 'lib/generated/azure_mgmt_graph/users.rb', line 647

def list_next_async(next_link, custom_headers = nil)
  fail ArgumentError, 'next_link is nil' if next_link.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # 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 = '/{tenantID}/{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      skip_encoding_path_params: {'nextLink' => next_link},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = UserListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_next_with_http_info(next_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets list of users for the current tenant.

will be added to the HTTP request.

Parameters:

  • next_link (String)

    Next link for list operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



634
635
636
# File 'lib/generated/azure_mgmt_graph/users.rb', line 634

def list_next_with_http_info(next_link, custom_headers = nil)
  list_next_async(next_link, custom_headers).value!
end

#list_with_http_info(filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets list of users for the current tenant. Reference msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#GetUsers

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



170
171
172
# File 'lib/generated/azure_mgmt_graph/users.rb', line 170

def list_with_http_info(filter = nil, custom_headers = nil)
  list_async(filter, custom_headers).value!
end

#update(upn_or_object_id, parameters, custom_headers = nil) ⇒ Object

Updates an exisitng user. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser

get user information. user. will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

  • parameters (UserUpdateParameters)

    Parameters to update an exisitng

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

    A hash of custom headers that



340
341
342
343
# File 'lib/generated/azure_mgmt_graph/users.rb', line 340

def update(upn_or_object_id, parameters, custom_headers = nil)
  response = update_async(upn_or_object_id, parameters, custom_headers).value!
  nil
end

#update_async(upn_or_object_id, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Updates an exisitng user. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser

get user information. user. to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

  • parameters (UserUpdateParameters)

    Parameters to update an exisitng

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/generated/azure_mgmt_graph/users.rb', line 375

def update_async(upn_or_object_id, parameters, custom_headers = nil)
  fail ArgumentError, 'upn_or_object_id is nil' if upn_or_object_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  api_version = '1.6'
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = UserUpdateParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/{tenantID}/users/{upnOrObjectId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      skip_encoding_path_params: {'upnOrObjectId' => upn_or_object_id},
      query_params: {'api-version' => 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
  end

  promise.execute
end

#update_with_http_info(upn_or_object_id, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an exisitng user. Reference: msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser

get user information. user. will be added to the HTTP request.

Parameters:

  • upn_or_object_id (String)

    User object Id or user principal name to

  • parameters (UserUpdateParameters)

    Parameters to update an exisitng

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



358
359
360
# File 'lib/generated/azure_mgmt_graph/users.rb', line 358

def update_with_http_info(upn_or_object_id, parameters, custom_headers = nil)
  update_async(upn_or_object_id, parameters, custom_headers).value!
end