Class: Azure::KeyVault::V7_2_preview::RoleDefinitions

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RoleDefinitions

Creates and initializes a new instance of the RoleDefinitions class.

Parameters:

  • client —

    service class for accessing basic functionality.



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.

Returns:



23
24
25
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 23

def client
  @client
end

Instance Method Details

#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.

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • scope (String) —

    The scope of the role definition.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Use

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

    A hash of custom headers that

Returns:

  • (Array<RoleDefinition>) —

    operation results.



38
39
40
41
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 38

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.

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • scope (String) —

    The scope of the role definition.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Use

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

    A hash of custom headers that

Returns:

  • (RoleDefinitionListResult) —

    which provide lazy access to pages of the



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 232

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.

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • scope (String) —

    The scope of the role definition.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Use

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 73

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)

  options = {
      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, 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::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.message, 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.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (RoleDefinitionListResult) —

    operation results.



138
139
140
141
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 138

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.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 167

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

  options = {
      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, 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::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.message, 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.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



153
154
155
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 153

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.

Parameters:

  • vault_base_url (String) —

    The vault name, for example

  • scope (String) —

    The scope of the role definition.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Use

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/7.2-preview/generated/azure_key_vault/role_definitions.rb', line 56

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