class Azure::DataBoxEdge::Mgmt::V2019_08_01::Users
Attributes
@return [DataBoxEdgeManagementClient] reference to the DataBoxEdgeManagementClient
Private Class Methods
Creates and initializes a new instance of the Users
class. @param client service class for accessing basic functionality.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 17 def initialize(client) @client = client end
Private Instance Methods
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param user [User] The user details. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [User] operation results.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 322 def begin_create_or_update(device_name, name, user, resource_group_name, custom_headers:nil) response = begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param user [User] The user details. @param resource_group_name [String] The resource group name. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 357 def begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers:nil) fail ArgumentError, 'device_name is nil' if device_name.nil? fail ArgumentError, 'name is nil' if name.nil? fail ArgumentError, 'user is nil' if user.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_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? # Serialize Request request_mapper = Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::User.mapper() request_content = @client.serialize(request_mapper, user) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_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 MsRestAzure::AzureOperationError.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::DataBoxEdge::Mgmt::V2019_08_01::Models::User.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
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param user [User] The user details. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 340 def begin_create_or_update_with_http_info(device_name, name, user, resource_group_name, custom_headers:nil) begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers:custom_headers).value! end
Deletes the user on a databox edge/gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 431 def begin_delete(device_name, name, resource_group_name, custom_headers:nil) response = begin_delete_async(device_name, name, resource_group_name, custom_headers:custom_headers).value! nil end
Deletes the user on a databox edge/gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 462 def begin_delete_async(device_name, name, resource_group_name, custom_headers:nil) fail ArgumentError, 'device_name is nil' if device_name.nil? fail ArgumentError, 'name is nil' if name.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_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 == 202 || status_code == 204 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.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
Deletes the user on a databox edge/gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 447 def begin_delete_with_http_info(device_name, name, resource_group_name, custom_headers:nil) begin_delete_async(device_name, name, resource_group_name, custom_headers:custom_headers).value! end
Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param user [User] The user details. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [User] operation results.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 235 def create_or_update(device_name, name, user, resource_group_name, custom_headers:nil) response = create_or_update_async(device_name, name, user, resource_group_name, custom_headers:custom_headers).value! response.body unless response.nil? end
@param device_name [String] The device name. @param name [String] The user name. @param user [User] The user details. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 251 def create_or_update_async(device_name, name, user, resource_group_name, custom_headers:nil) # Send request promise = begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::User.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
Deletes the user on a databox edge/gateway device.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 278 def delete(device_name, name, resource_group_name, custom_headers:nil) response = delete_async(device_name, name, resource_group_name, custom_headers:custom_headers).value! nil end
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 293 def delete_async(device_name, name, resource_group_name, custom_headers:nil) # Send request promise = begin_delete_async(device_name, name, resource_group_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
Gets the properties of the specified user.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [User] operation results.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 135 def get(device_name, name, resource_group_name, custom_headers:nil) response = get_async(device_name, name, resource_group_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets the properties of the specified user.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 166 def get_async(device_name, name, resource_group_name, custom_headers:nil) fail ArgumentError, 'device_name is nil' if device_name.nil? fail ArgumentError, 'name is nil' if name.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_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 MsRestAzure::AzureOperationError.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::DataBoxEdge::Mgmt::V2019_08_01::Models::User.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
Gets the properties of the specified user.
@param device_name [String] The device name. @param name [String] The user name. @param resource_group_name [String] The resource group name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 151 def get_with_http_info(device_name, name, resource_group_name, custom_headers:nil) get_async(device_name, name, resource_group_name, custom_headers:custom_headers).value! end
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param resource_group_name [String] The resource group name. @param filter [String] Specify $filter='UserType eq <type>' to filter on user type property @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<User>] operation results.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 36 def list_by_data_box_edge_device(device_name, resource_group_name, filter:nil, custom_headers:nil) first_page = list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, filter:filter, custom_headers:custom_headers) first_page.get_all_items end
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param resource_group_name [String] The resource group name. @param filter [String] Specify $filter='UserType eq <type>' to filter on user type property @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [UserList] which provide lazy access to pages of the response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 610 def list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, filter:nil, custom_headers:nil) response = list_by_data_box_edge_device_async(device_name, resource_group_name, filter:filter, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_data_box_edge_device_next_async(next_page_link, custom_headers:custom_headers) end page end end
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param resource_group_name [String] The resource group name. @param filter [String] Specify $filter='UserType eq <type>' to filter on user type property @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 69 def list_by_data_box_edge_device_async(device_name, resource_group_name, filter:nil, custom_headers:nil) fail ArgumentError, 'device_name is nil' if device_name.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'deviceName' => device_name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name}, query_params: {'api-version' => @client.api_version,'$filter' => filter}, 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 MsRestAzure::AzureOperationError.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::DataBoxEdge::Mgmt::V2019_08_01::Models::UserList.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
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [UserList] operation results.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 518 def list_by_data_box_edge_device_next(next_page_link, custom_headers:nil) response = list_by_data_box_edge_device_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 547 def list_by_data_box_edge_device_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 MsRestAzure::AzureOperationError.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::DataBoxEdge::Mgmt::V2019_08_01::Models::UserList.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
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 533 def list_by_data_box_edge_device_next_with_http_info(next_page_link, custom_headers:nil) list_by_data_box_edge_device_next_async(next_page_link, custom_headers:custom_headers).value! end
Gets all the users registered on a Data Box Edge/Data Box Gateway device.
@param device_name [String] The device name. @param resource_group_name [String] The resource group name. @param filter [String] Specify $filter='UserType eq <type>' to filter on user type property @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb, line 53 def list_by_data_box_edge_device_with_http_info(device_name, resource_group_name, filter:nil, custom_headers:nil) list_by_data_box_edge_device_async(device_name, resource_group_name, filter:filter, custom_headers:custom_headers).value! end