Class: Azure::KeyVault::V7_2_preview::RoleAssignments
- Inherits:
-
Object
- Object
- Azure::KeyVault::V7_2_preview::RoleAssignments
- Includes:
- MsRestAzure
- Defined in:
- lib/7.2-preview/generated/azure_key_vault/role_assignments.rb
Overview
The key vault client performs cryptographic key operations and vault operations against the Key Vault service.
Instance Attribute Summary collapse
-
#client ⇒ KeyVaultClient
readonly
Reference to the KeyVaultClient.
Instance Method Summary collapse
-
#create(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ RoleAssignment
Creates a role assignment.
-
#create_async(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a role assignment.
-
#create_with_http_info(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a role assignment.
-
#delete(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ RoleAssignment
Deletes a role assignment.
-
#delete_async(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a role assignment.
-
#delete_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a role assignment.
-
#get(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ RoleAssignment
Get the specified role assignment.
-
#get_async(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ Concurrent::Promise
Get the specified role assignment.
-
#get_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get the specified role assignment.
-
#initialize(client) ⇒ RoleAssignments
constructor
Creates and initializes a new instance of the RoleAssignments class.
-
#list_for_scope(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Array<RoleAssignment>
Gets role assignments for a scope.
-
#list_for_scope_as_lazy(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ RoleAssignmentListResult
Gets role assignments for a scope.
-
#list_for_scope_async(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Gets role assignments for a scope.
-
#list_for_scope_next(next_page_link, custom_headers: nil) ⇒ RoleAssignmentListResult
Gets role assignments for a scope.
-
#list_for_scope_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Gets role assignments for a scope.
-
#list_for_scope_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets role assignments for a scope.
-
#list_for_scope_with_http_info(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets role assignments for a scope.
Constructor Details
#initialize(client) ⇒ RoleAssignments
Creates and initializes a new instance of the RoleAssignments class.
18 19 20 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 18 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ KeyVaultClient (readonly)
Returns reference to the KeyVaultClient.
23 24 25 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 23 def client @client end |
Instance Method Details
#create(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ RoleAssignment
Creates a role assignment.
myvault.vault.azure.net. create. It can be any valid GUID. assignment. will be added to the HTTP request.
145 146 147 148 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 145 def create(vault_base_url, scope, role_assignment_name, parameters, custom_headers:nil) response = create_async(vault_base_url, scope, role_assignment_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_async(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a role assignment.
myvault.vault.azure.net. create. It can be any valid GUID. assignment. to the HTTP request.
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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 184 def create_async(vault_base_url, scope, role_assignment_name, parameters, custom_headers:nil) fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil? fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_assignment_name is nil' if role_assignment_name.nil? fail ArgumentError, 'parameters is nil' if parameters.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::KeyVault::V7_2_preview::Models::RoleAssignmentCreateParameters.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = '{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleAssignmentName' => role_assignment_name}, skip_encoding_path_params: {'scope' => scope}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 201 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::KeyVault::V7_2_preview::Models::RoleAssignment.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_with_http_info(vault_base_url, scope, role_assignment_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a role assignment.
myvault.vault.azure.net. create. It can be any valid GUID. assignment. will be added to the HTTP request.
165 166 167 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 165 def create_with_http_info(vault_base_url, scope, role_assignment_name, parameters, custom_headers:nil) create_async(vault_base_url, scope, role_assignment_name, parameters, custom_headers:custom_headers).value! end |
#delete(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ RoleAssignment
Deletes a role assignment.
myvault.vault.azure.net. delete. will be added to the HTTP request.
38 39 40 41 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 38 def delete(vault_base_url, scope, role_assignment_name, custom_headers:nil) response = delete_async(vault_base_url, scope, role_assignment_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#delete_async(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a role assignment.
myvault.vault.azure.net. delete. to the HTTP request.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 73 def delete_async(vault_base_url, scope, role_assignment_name, custom_headers:nil) fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil? fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_assignment_name is nil' if role_assignment_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = '{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleAssignmentName' => role_assignment_name}, skip_encoding_path_params: {'scope' => scope}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:delete, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 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::KeyVault::V7_2_preview::Models::RoleAssignment.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#delete_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a role assignment.
myvault.vault.azure.net. delete. will be added to the HTTP request.
56 57 58 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 56 def delete_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers:nil) delete_async(vault_base_url, scope, role_assignment_name, custom_headers:custom_headers).value! end |
#get(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ RoleAssignment
Get the specified role assignment.
myvault.vault.azure.net. will be added to the HTTP request.
261 262 263 264 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 261 def get(vault_base_url, scope, role_assignment_name, custom_headers:nil) response = get_async(vault_base_url, scope, role_assignment_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ Concurrent::Promise
Get the specified role assignment.
myvault.vault.azure.net. to the HTTP request.
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 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 294 def get_async(vault_base_url, scope, role_assignment_name, custom_headers:nil) fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil? fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, 'role_assignment_name is nil' if role_assignment_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = '{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}' request_url = @base_url || @client.base_url request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'roleAssignmentName' => role_assignment_name}, skip_encoding_path_params: {'scope' => scope}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::KeyVault::V7_2_preview::Models::RoleAssignment.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get the specified role assignment.
myvault.vault.azure.net. will be added to the HTTP request.
278 279 280 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 278 def get_with_http_info(vault_base_url, scope, role_assignment_name, custom_headers:nil) get_async(vault_base_url, scope, role_assignment_name, custom_headers:custom_headers).value! end |
#list_for_scope(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Array<RoleAssignment>
Gets role assignments for a scope.
myvault.vault.azure.net. $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq id to return all role assignments at, above or below the scope for the specified principal. will be added to the HTTP request.
366 367 368 369 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 366 def list_for_scope(vault_base_url, scope, filter:nil, custom_headers:nil) first_page = list_for_scope_as_lazy(vault_base_url, scope, filter:filter, custom_headers:custom_headers) first_page.get_all_items end |
#list_for_scope_as_lazy(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ RoleAssignmentListResult
Gets role assignments for a scope.
myvault.vault.azure.net. $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq id to return all role assignments at, above or below the scope for the specified principal. will be added to the HTTP request.
response.
566 567 568 569 570 571 572 573 574 575 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 566 def list_for_scope_as_lazy(vault_base_url, scope, filter:nil, custom_headers:nil) response = list_for_scope_async(vault_base_url, scope, filter:filter, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_for_scope_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_for_scope_async(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Gets role assignments for a scope.
myvault.vault.azure.net. $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq id to return all role assignments at, above or below the scope for the specified principal. to the HTTP request.
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 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 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 405 def list_for_scope_async(vault_base_url, scope, filter:nil, custom_headers:nil) fail ArgumentError, 'vault_base_url is nil' if vault_base_url.nil? fail ArgumentError, 'scope is nil' if scope.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = '{scope}/providers/Microsoft.Authorization/roleAssignments' request_url = @base_url || @client.base_url request_url = request_url.gsub('{vaultBaseUrl}', vault_base_url) = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'scope' => scope}, query_params: {'$filter' => filter,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::KeyVault::V7_2_preview::Models::RoleAssignmentListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_for_scope_next(next_page_link, custom_headers: nil) ⇒ RoleAssignmentListResult
Gets role assignments for a scope.
to List operation. will be added to the HTTP request.
470 471 472 473 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 470 def list_for_scope_next(next_page_link, custom_headers:nil) response = list_for_scope_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_for_scope_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Gets role assignments for a scope.
to List operation. to the HTTP request.
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 499 def list_for_scope_next_async(next_page_link, custom_headers:nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = '{nextLink}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'nextLink' => next_page_link}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail 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::KeyVault::V7_2_preview::Models::RoleAssignmentListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_for_scope_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets role assignments for a scope.
to List operation. will be added to the HTTP request.
485 486 487 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 485 def list_for_scope_next_with_http_info(next_page_link, custom_headers:nil) list_for_scope_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_for_scope_with_http_info(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets role assignments for a scope.
myvault.vault.azure.net. $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq id to return all role assignments at, above or below the scope for the specified principal. will be added to the HTTP request.
386 387 388 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_assignments.rb', line 386 def list_for_scope_with_http_info(vault_base_url, scope, filter:nil, custom_headers:nil) list_for_scope_async(vault_base_url, scope, filter:filter, custom_headers:custom_headers).value! end |