Class: Azure::KeyVault::V7_2_preview::RoleDefinitions
- Inherits:
-
Object
- Object
- Azure::KeyVault::V7_2_preview::RoleDefinitions
- Includes:
- MsRestAzure
- Defined in:
- lib/7.2-preview/generated/azure_key_vault/role_definitions.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_or_update(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ RoleDefinition
Creates or updates a custom role definition.
-
#create_or_update_async(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates a custom role definition.
-
#create_or_update_with_http_info(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a custom role definition.
-
#delete(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ RoleDefinition
Deletes a custom role definition.
-
#delete_async(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a custom role definition.
-
#delete_with_http_info(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a custom role definition.
-
#get(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ RoleDefinition
Get the specified role definition.
-
#get_async(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ Concurrent::Promise
Get the specified role definition.
-
#get_with_http_info(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get the specified role definition.
-
#initialize(client) ⇒ RoleDefinitions
constructor
Creates and initializes a new instance of the RoleDefinitions class.
-
#list(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Array<RoleDefinition>
Get all role definitions that are applicable at scope and above.
-
#list_as_lazy(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
-
#list_async(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
-
#list_next(next_page_link, custom_headers: nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
-
#list_with_http_info(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
Constructor Details
#initialize(client) ⇒ RoleDefinitions
Creates and initializes a new instance of the RoleDefinitions class.
18 19 20 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.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_definitions.rb', line 23 def client @client end |
Instance Method Details
#create_or_update(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ RoleDefinition
Creates or updates a custom role definition.
myvault.vault.azure.net. Managed HSM only supports ‘/’. create or update. It can be any valid GUID. definition. will be added to the HTTP request.
149 150 151 152 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 149 def create_or_update(vault_base_url, scope, role_definition_name, parameters, custom_headers:nil) response = create_or_update_async(vault_base_url, scope, role_definition_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates or updates a custom role definition.
myvault.vault.azure.net. Managed HSM only supports ‘/’. create or update. It can be any valid GUID. definition. to the HTTP request.
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 248 249 250 251 252 253 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 190 def create_or_update_async(vault_base_url, scope, role_definition_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_definition_name is nil' if role_definition_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::RoleDefinitionCreateParameters.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/roleDefinitions/{roleDefinitionName}' 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: {'roleDefinitionName' => role_definition_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::RoleDefinition.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_or_update_with_http_info(vault_base_url, scope, role_definition_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates or updates a custom role definition.
myvault.vault.azure.net. Managed HSM only supports ‘/’. create or update. It can be any valid GUID. definition. will be added to the HTTP request.
170 171 172 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 170 def create_or_update_with_http_info(vault_base_url, scope, role_definition_name, parameters, custom_headers:nil) create_or_update_async(vault_base_url, scope, role_definition_name, parameters, custom_headers:custom_headers).value! end |
#delete(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ RoleDefinition
Deletes a custom role definition.
myvault.vault.azure.net. only supports ‘/’. to delete. will be added to the HTTP request.
39 40 41 42 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 39 def delete(vault_base_url, scope, role_definition_name, custom_headers:nil) response = delete_async(vault_base_url, scope, role_definition_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#delete_async(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a custom role definition.
myvault.vault.azure.net. only supports ‘/’. to delete. to the HTTP request.
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 129 130 131 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 76 def delete_async(vault_base_url, scope, role_definition_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_definition_name is nil' if role_definition_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/roleDefinitions/{roleDefinitionName}' 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: {'roleDefinitionName' => role_definition_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::RoleDefinition.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_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a custom role definition.
myvault.vault.azure.net. only supports ‘/’. to delete. will be added to the HTTP request.
58 59 60 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 58 def delete_with_http_info(vault_base_url, scope, role_definition_name, custom_headers:nil) delete_async(vault_base_url, scope, role_definition_name, custom_headers:custom_headers).value! end |
#get(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ RoleDefinition
Get the specified role definition.
myvault.vault.azure.net. only supports ‘/’. will be added to the HTTP request.
268 269 270 271 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 268 def get(vault_base_url, scope, role_definition_name, custom_headers:nil) response = get_async(vault_base_url, scope, role_definition_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(vault_base_url, scope, role_definition_name, custom_headers: nil) ⇒ Concurrent::Promise
Get the specified role definition.
myvault.vault.azure.net. only supports ‘/’. to the HTTP request.
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 303 def get_async(vault_base_url, scope, role_definition_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_definition_name is nil' if role_definition_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/roleDefinitions/{roleDefinitionName}' 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: {'roleDefinitionName' => role_definition_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::RoleDefinition.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_definition_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get the specified role definition.
myvault.vault.azure.net. only supports ‘/’. will be added to the HTTP request.
286 287 288 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 286 def get_with_http_info(vault_base_url, scope, role_definition_name, custom_headers:nil) get_async(vault_base_url, scope, role_definition_name, custom_headers:custom_headers).value! end |
#list(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Array<RoleDefinition>
Get all role definitions that are applicable at scope and above.
myvault.vault.azure.net. atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
373 374 375 376 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 373 def list(vault_base_url, scope, filter:nil, custom_headers:nil) first_page = list_as_lazy(vault_base_url, scope, filter:filter, custom_headers:custom_headers) first_page.get_all_items end |
#list_as_lazy(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
myvault.vault.azure.net. atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
response.
567 568 569 570 571 572 573 574 575 576 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 567 def list_as_lazy(vault_base_url, scope, filter:nil, custom_headers:nil) response = list_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_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_async(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
myvault.vault.azure.net. atScopeAndBelow filter to search below the given scope as well. to the HTTP request.
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 459 460 461 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 408 def list_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/roleDefinitions' 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::RoleDefinitionListResult.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_next(next_page_link, custom_headers: nil) ⇒ RoleDefinitionListResult
Get all role definitions that are applicable at scope and above.
to List operation. will be added to the HTTP request.
473 474 475 476 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 473 def list_next(next_page_link, custom_headers:nil) response = list_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Get all role definitions that are applicable at scope and above.
to List operation. to the HTTP request.
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 549 550 551 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 502 def list_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::RoleDefinitionListResult.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
to List operation. will be added to the HTTP request.
488 489 490 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 488 def list_next_with_http_info(next_page_link, custom_headers:nil) list_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_with_http_info(vault_base_url, scope, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Get all role definitions that are applicable at scope and above.
myvault.vault.azure.net. atScopeAndBelow filter to search below the given scope as well. will be added to the HTTP request.
391 392 393 |
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 391 def list_with_http_info(vault_base_url, scope, filter:nil, custom_headers:nil) list_async(vault_base_url, scope, filter:filter, custom_headers:custom_headers).value! end |