Class: Azure::Synapse::Mgmt::V2019_06_01_preview::WorkspaceAadAdmins

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb

Overview

Azure Synapse Analytics Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkspaceAadAdmins

Creates and initializes a new instance of the WorkspaceAadAdmins class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SynapseManagementClient (readonly)

Returns reference to the SynapseManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, workspace_name, aad_admin_info, custom_headers: nil) ⇒ WorkspaceAadAdminInfo

Creates or updates a workspace active directory admin

is case insensitive. administrator properties will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • aad_admin_info (WorkspaceAadAdminInfo) —

    Workspace active directory

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

    A hash of custom headers that

Returns:

  • (WorkspaceAadAdminInfo) —

    operation results.



227
228
229
230
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 227

def begin_create_or_update(resource_group_name, workspace_name, aad_admin_info, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a workspace active directory admin

is case insensitive. administrator properties to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • aad_admin_info (WorkspaceAadAdminInfo) —

    Workspace active directory

  • 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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 262

def begin_create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, 'aad_admin_info is nil' if aad_admin_info.nil?


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

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

  # Serialize Request
  request_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::WorkspaceAadAdminInfo.mapper()
  request_content = @client.serialize(request_mapper,  aad_admin_info)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory'

  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,'workspaceName' => workspace_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 == 200 || status_code == 202
      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::Synapse::Mgmt::V2019_06_01_preview::Models::WorkspaceAadAdminInfo.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::WorkspaceAadAdminInfo.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

#begin_create_or_update_with_http_info(resource_group_name, workspace_name, aad_admin_info, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a workspace active directory admin

is case insensitive. administrator properties will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • aad_admin_info (WorkspaceAadAdminInfo) —

    Workspace active directory

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



245
246
247
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 245

def begin_create_or_update_with_http_info(resource_group_name, workspace_name, aad_admin_info, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, workspace_name, custom_headers: nil) ⇒ Object

Deletes a workspace active directory admin

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that



350
351
352
353
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 350

def begin_delete(resource_group_name, workspace_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, workspace_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, workspace_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a workspace active directory admin

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
426
427
428
429
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 381

def begin_delete_async(resource_group_name, workspace_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_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.Synapse/workspaces/{workspaceName}/administrators/activeDirectory'

  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,'workspaceName' => workspace_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 || status_code == 202
      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

#begin_delete_with_http_info(resource_group_name, workspace_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a workspace active directory admin

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



366
367
368
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 366

def begin_delete_with_http_info(resource_group_name, workspace_name, custom_headers:nil)
  begin_delete_async(resource_group_name, workspace_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, workspace_name, aad_admin_info, custom_headers: nil) ⇒ WorkspaceAadAdminInfo

Creates or updates a workspace active directory admin

is case insensitive. administrator properties will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • aad_admin_info (WorkspaceAadAdminInfo) —

    Workspace active directory

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

    A hash of custom headers that

Returns:

  • (WorkspaceAadAdminInfo) —

    operation results.



139
140
141
142
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 139

def create_or_update(resource_group_name, workspace_name, aad_admin_info, custom_headers:nil)
  response = create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. administrator properties will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • aad_admin_info (WorkspaceAadAdminInfo) —

    Workspace active directory

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 156

def create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, workspace_name, aad_admin_info, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::WorkspaceAadAdminInfo.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, workspace_name, custom_headers: nil) ⇒ Object

Deletes a workspace active directory admin

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that



183
184
185
186
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 183

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

#delete_async(resource_group_name, workspace_name, custom_headers: nil) ⇒ Concurrent::Promise

is case insensitive. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 198

def delete_async(resource_group_name, workspace_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, workspace_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, workspace_name, custom_headers: nil) ⇒ WorkspaceAadAdminInfo

Gets a workspace active directory admin

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that

Returns:

  • (WorkspaceAadAdminInfo) —

    operation results.



35
36
37
38
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 35

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

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

Gets a workspace active directory admin

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 66

def get_async(resource_group_name, workspace_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_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.Synapse/workspaces/{workspaceName}/administrators/activeDirectory'

  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,'workspaceName' => workspace_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::Synapse::Mgmt::V2019_06_01_preview::Models::WorkspaceAadAdminInfo.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, workspace_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a workspace active directory admin

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/workspace_aad_admins.rb', line 51

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